Comments (3)
Moving this here from the README:
- List of things to consider for breaking changes
- Changed type of parameter
- Changed type of public module attribute
- Changed return type of a public function/method
- All of the previous even when parent is private (could be publicly imported or assigned somewhere),
and later be smarter: public assign/import makes private things public! - Inheritance: removed, added or changed base that changes MRO
from griffe.
I wonder: could we somehow recurse into objects to check that they implement the same "protocols"? Example:
class Foo:
def method1(self): ...
def method2(self, param1: int, param2: int): ...
class Bar:
def method2(self, param1: int, param2: int): ...
class Baz:
def method1(self): ...
def method2(self, param1: int): ...
class Qux:
def method1(self): ...
def method2(self, param1: str, param2: int): ...
class Quux:
def method1(self): ...
def method2(self, param1: int, param2: int): ...
def method3(self): ...
def f_old(param: Foo): ...
def f_new(param: Bar): ... # breaks: removed method1
def f_new(param: Baz): ... # breaks: removed param2 on method2
def f_new(param: Qux): ... # breaks: changed type of param1 on method2 (int -> str is a "known" breakage)
def f_new(param: Quux): ... # doesn't break: added method3
I imagine a type_compatible(self, other)
method on objects that uses next(find_breaking_changes(self, other))
and returns False if a breakage is yielded, True if StopIteration is raised.
from griffe.
Or maybe there's a way to hook into mypy...
from griffe.
Related Issues (20)
- bug: parsing of annotations placed after parameters section fails HOT 1
- docs: Add an example CI setup HOT 1
- bug: Custom implementation of cached_property results in property being categorized as a "method" instead of a cached property HOT 7
- bug: Google docstrings: no support for non-multiple or non-named values in Yields section HOT 3
- feature: extension(?): relative cross-references in docstrings, but resolved by the handler/extractor HOT 6
- feature: Pre-commit integration HOT 4
- feature: Allow passing multiple args to `Object.has_labels` instead of a set
- feature: Allow passing multiple args to `load_extensions` instead of a list
- bug: bad handling of str module_path in loader.py:_load_module_path HOT 2
- feature: Populate lines collection within helpers
- refactor: Change the logic for the `lines` property of objects
- refactor: Maybe rework the logic for objects `lines` or `source` HOT 1
- bug: setuptools editable install finder with ast.AnnAssign leads to unfound modules HOT 3
- bug: griffe doesn't render dynamic docstrings HOT 2
- bug: Different results when checking API breaking changes with static and dynamic analysis
- refactor: Rewrite diff logic to actually return differences, not just breaking changes
- refactor: Rework public API
- docs: Improve docstrings and docs HOT 1
- refactor: Rework "exported" and "public" logic
- feature: Support conventions to mark objects as public HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from griffe.