Add as_packages to Forbidden contracts #229
Open
+310
−114
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
NicholasBunn
force-pushed
the
feature/add_package_support_to_forbidden_contracts
branch
4 times, most recently
from
937046f to
9227c71
Compare
NicholasBunn
force-pushed
the
feature/add_package_support_to_forbidden_contracts
branch
2 times, most recently
from
70ff3b4 to
84c664e
Compare
NicholasBunn
force-pushed
the
feature/add_package_support_to_forbidden_contracts
branch
2 times, most recently
from
063c8be to
c2a9d25
Compare
NicholasBunn
commented
Nov 8, 2024
Comment on lines
+105
to
+142
| ( | ||
| False, | ||
| ( | ||
| "mypackage.blue", | ||
| "mypackage.green", | ||
| "mypackage.yellow", | ||
| "mypackage.purple", | ||
| ), | ||
| [ | ||
| { | ||
| "upstream_module": "mypackage.green", | ||
| "downstream_module": "mypackage.three", | ||
| "chains": [ | ||
| [ | ||
| { | ||
| "importer": "mypackage.three", | ||
| "imported": "mypackage.green", | ||
| "line_numbers": (4,), | ||
| } | ||
| ] | ||
| ], | ||
| }, | ||
| { | ||
| "upstream_module": "mypackage.purple", | ||
| "downstream_module": "mypackage.two", | ||
| "chains": [ | ||
| [ | ||
| { | ||
| "importer": "mypackage.two", | ||
| "imported": "mypackage.utils", | ||
| "line_numbers": (9,), | ||
| }, | ||
| { | ||
| "importer": "mypackage.utils", | ||
| "imported": "mypackage.purple", | ||
| "line_numbers": (1,), | ||
| }, | ||
| ] | ||
| ], | ||
| }, | ||
| ], | ||
| ), | ||
| ], | ||
| ) |
NicholasBunn
commented
Nov 8, 2024
| @pytest.mark.parametrize( | ||
| "as_packages", | ||
| ( | ||
| ("False"), |
NicholasBunn
commented
Nov 8, 2024
| def test_is_broken_when_forbidden_external_modules_imported(self): | ||
| @pytest.mark.parametrize( | ||
| "as_packages", | ||
| (False, True), |
NicholasBunn
commented
Nov 8, 2024
| @pytest.mark.parametrize( | ||
| "as_packages", | ||
| ( | ||
| ("False"), |
NicholasBunn
commented
Nov 8, 2024
| @pytest.mark.parametrize( | ||
| "as_packages", | ||
| ( | ||
| ("False"), |
NicholasBunn
commented
Nov 8, 2024
Comment on lines
+455
to
+466
| False, | ||
| ("mypackage.green",), | ||
| [ | ||
| { | ||
| "upstream_module": "mypackage.green", | ||
| "downstream_module": "mypackage.three", | ||
| "chains": [ | ||
| [ | ||
| { | ||
| "importer": "mypackage.three", | ||
| "imported": "mypackage.green", | ||
| "line_numbers": (4,), | ||
| }, | ||
| ] | ||
| ], | ||
| }, | ||
| ], | ||
| ), |
NicholasBunn
commented
Nov 8, 2024
| def test_ignore_imports_with_recursive_wildcards(self): | ||
| @pytest.mark.parametrize( | ||
| "as_packages", | ||
| (False, True), |
NicholasBunn
commented
Nov 8, 2024
| @pytest.mark.parametrize( | ||
| "as_packages", | ||
| ( | ||
| ("False"), |
NicholasBunn
commented
Nov 8, 2024
| @pytest.mark.parametrize( | ||
| "as_packages", | ||
| ( | ||
| ("False"), |
NicholasBunn
commented
Nov 8, 2024
| * Fabian Binz - https://github.com/fbinz |
There was a problem hiding this comment.
Not sure why this has registered as a change 🤔
There was a problem hiding this comment.
It's just because there is a line ending added to the end of that line.
NicholasBunn
force-pushed
the
feature/add_package_support_to_forbidden_contracts
branch
from
c2a9d25 to
d202c51
Compare
seddonym
requested changes
Nov 25, 2024
There was a problem hiding this comment.
Looking great!
I would approve it, but the checks aren't passing. I suspect you'll need to put # type:ignore comments on those - contract fields don't play well with mypy.
Nothing else is blocking. If you felt like adding public facing docs then that would be appreciated, but I can also do it in a follow up if you prefer.
| * Fabian Binz - https://github.com/fbinz |
There was a problem hiding this comment.
It's just because there is a line ending added to the end of that line.
NicholasBunn
force-pushed
the
feature/add_package_support_to_forbidden_contracts
branch
from
d202c51 to
8165aaa
Compare
seddonym
requested changes
Nov 25, 2024
NicholasBunn
force-pushed
the
feature/add_package_support_to_forbidden_contracts
branch
2 times, most recently
from
754e08d to
a3b20e3
Compare
seddonym
approved these changes
Dec 4, 2024
Implement the funcitonality for treating the forbidden modules as a module rather than a package. If this is specified, we set the source_moduels and forbidden_modules as the package name rather than finding all downstream modules of that package.
NicholasBunn
force-pushed
the
feature/add_package_support_to_forbidden_contracts
branch
from
a3b20e3 to
83f2e8d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following on from the work to add further
as_packagessupport to Grimp here, this PR adds theas_packagesoptions to Forbidden contracts so that we can forbid modules in addition to entire packages. The default behaviour remains, treating all imports as packagesThis change would serve to fix this issue (or implement the feature, I guess?)