-
-
Notifications
You must be signed in to change notification settings - Fork 56
[WIP] feat: Moved non‑standard implementations to Contrib area #916
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Coverage summary from CodacySee diff coverage on Codacy
Coverage variation details
Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: Diff coverage details
Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: See your quality gate settings Change summary preferences |
cfe1a70 to
df53a77
Compare
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
df53a77 to
f6430ec
Compare
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR reorganizes code by introducing a new contrib (contributed/community) area for non-standard features and deprecating the old import paths. The changes prepare the library for clearer separation between core CycloneDX specification functionality and community-contributed utilities.
- Moved
LicenseFactoryfromcyclonedx.factory.licensetocyclonedx.contrib.license.factories - Moved
this_component()andthis_tool()builders fromcyclonedx.builder.thistocyclonedx.contrib.this.builders - Created deprecation wrappers at old locations with appropriate warnings directing users to new import paths
Reviewed changes
Copilot reviewed 14 out of 15 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
cyclonedx/contrib/README.md |
Documents the purpose and guidelines for the new contrib area |
cyclonedx/contrib/__init__.py |
Initializes contrib package with explanatory docstring |
cyclonedx/contrib/license/__init__.py |
Package initialization for license-related contrib code |
cyclonedx/contrib/license/factories.py |
New location for LicenseFactory implementation |
cyclonedx/contrib/this/__init__.py |
Package initialization for self-representation contrib code |
cyclonedx/contrib/this/builders.py |
New location for this_component() and this_tool() implementations |
cyclonedx/factory/license.py |
Deprecated re-export wrapper for backward compatibility |
cyclonedx/builder/this.py |
Deprecated re-export wrappers for backward compatibility |
tests/test_factory_license.py |
Updated mock patch paths to new module locations |
tests/test_real_world_examples.py |
Updated mock patch path to new module location |
tests/test_output_xml.py |
Updated mock patch path to new module location |
tests/test_output_json.py |
Updated mock patch path to new module location |
tests/test_deserialize_xml.py |
Updated mock patch path to new module location |
tests/test_deserialize_json.py |
Updated mock patch path to new module location |
tests/test_contrib/.gitkeep |
Placeholder for future contrib test directory |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Added
Changed
Deprecated
Note: the symbols themselves remain supported. See documentation and the "Refactored" section below for details.
Refactored
The symbols are still import-able through their old location.
TODO