Finalize switch flow #207
Finalize switch flow #207
Conversation
Note: Added a converter class for scancode to Opossum to allow for individual testing
* Resolved conflicts src/opossum_lib/cli.py * Needed to adapt (as this now contains functionality which has been in cli.py) * src/opossum_lib/core/input_file.py * src/opossum_lib/core/opossum_generation_arguments.py * src/opossum_lib/core/opossum_generator.py
Goal: The different file formats should not depend on each other
Hellgartner
force-pushed
the
finalize_switch_flow
branch
from
246dcb0 to
b1d0e2d
Compare
This allows to write a rule for import linter which automatically extends on new packages
src/opossum_lib/input_formats/scancode/scancode_data_to_opossum_converter.py
Outdated
Show resolved
Hide resolved
* Remove the warning log if the output file is overwritten * It is not useful for the user as it she/he cannot react on the message * Instead, put a clearer warning in the docs + help message
* This also allows to activate the next importlinter rule
* For each package add a substructure * entities * services * Move the global model to a shared package
* renaming * fix surplus plus * added comment
To better match name and content
| COMPRESSION_LEVEL, | ||
| INPUT_JSON_NAME, | ||
| OUTPUT_JSON_NAME, | ||
| ) | ||
| from opossum_lib.opossum.opossum_file_content import OpossumFileContent | ||
| from opossum_lib.shared.entities.opossum_file_model import OpossumFileModel | ||
|
|
||
|
|
||
| class OpossumFileWriter: |
There was a problem hiding this comment.
I think these classes that only contain @staticmethods are not idiomatic in Python.
You get the very same behavior if you make the methods simply top-level methods of the module. I'd prefer removing the unnecessary classes.
There was a problem hiding this comment.
Also I'd propose a different split into functions:
def _dump_to_json(model: BaseModel) -> str:
model.model_dump_json(exclude_none=True, indent=4, by_alias=True)
def write(opossum_file_model: OpossumFileModel, file_path: Path) -> None:
file_path = file_path.with_suffix(".opossum")
with ZipFile(file_path, "w", compression=ZIP_DEFLATED, compresslevel=COMPRESSION_LEVEL) as zip_file:
zip_file.writestr(INPUT_JSON_NAME, _dump_to_json(opossum_file_model.input_file))
if opossum_file_model.output_file:
zip_file.writestr(OUTPUT_JSON_NAME, _dump_to_json(opossum_file_model.output_file))Which I find much more readable
There was a problem hiding this comment.
I think these classes that only contain
@staticmethodsare not idiomatic in Python.
You get the very same behavior if you make the methods simply top-level methods of the module. I'd prefer removing the unnecessary classes.
When syncing with @mstykow we agreed on explicilty having these classes so I would like to keep them
There was a problem hiding this comment.
ok. Let's keep these then. What do you think about the different organization of methods?
|
|
||
| return ScancodeDataToOpossumConverter.convert_scancode_to_opossum(scancode_data) | ||
|
|
||
| @staticmethod |
There was a problem hiding this comment.
Why is this a static method?
If it is internal, then use an "_" (and make it an instance method to hide it even more). If it is API then it can just be a top-level method.
|
|
||
| class ScancodeDataToOpossumConverter: | ||
| @staticmethod | ||
| def convert_scancode_to_opossum(scancode_data: ScanCodeDataModel) -> Opossum: |
There was a problem hiding this comment.
I think only this method is public and the rest should be internal -> prefix with "_"
Consider removing the wrapping class as the namespacing gets a bit too much: SCANCODE.services.SCANCODE_data_to_opossum_converter.SCANCODEDataToOpossumConverter.convert_SCANCODE_to_opossum (emphasis on how often scancode appears)
|
|
||
|
|
||
| class ScanCodeData(BaseModel): | ||
| class ScanCodeDataModel(BaseModel): |
There was a problem hiding this comment.
scan_code -> scancode and instead of "data" perhaps "file"
| class ScanCodeDataModel(BaseModel): | |
| class ScancodeFileModel(BaseModel): |
* remove filler word data * scancode is treated as one word
* rename to file reader * make the member function private
Goal: Match the project structure as good as possible
Closes #199
Goal is to move to a global flow which is