♻️ Splits models_library.services

pcrespov commented 3 weeks ago

What do these changes do?

♻️ Splits models_library.services into more manageable sub-modules. This is the rationale
- the module/submodules follow a structure similar to e.g. aiohttp
  - models_library.services acts as the main module API
  - models_library.services_* act as submodules. Can be either imported directly and/or some functionality is exposed to the main module API
- highlights differences between different service metadata (SMD) models and how they are composed. We have SMD models for:
  1. image (static)
  2. database (user-defined, editable)
  3. webserver API schema ( GET/PATCH )
  4. catalog API schema ( GET/PATCH )
🔨 new make doc-uml on any package to produce UML diagrams. Based in pyreverse which comes with pylint.

Related issue/s

resolves https://github.com/ITISFoundation/osparc-simcore/issues/3486
preparation for https://github.com/ITISFoundation/osparc-issues/issues/1404

How to test

Using doc-uml to trace code inhertance/composition relations between models
- cd packages/models-library (or any other package/service)
- make -n doc-uml
- (export DOC_UML_PATH_SUFFIX="services*"; export DOC_UML_CLASS=models_library.api_schemas_catalog.services.ServiceGet; make doc-uml)
- will produce a UML diagram

Dev-ops checklist

None

codecov[bot] commented 3 weeks ago

Codecov Report

Attention: Patch coverage is 93.02326% with 18 lines in your changes missing coverage. Please review.

Project coverage is 88.2%. Comparing base (cafbf96) to head (aa360be). Report is 276 commits behind head on master.

Additional details and impacted files

[![Impacted file tree graph](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921/graphs/tree.svg?width=650&height=150&src=pr&token=h1rOE8q7ic&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation)](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation) ```diff @@ Coverage Diff @@ ## master #5921 +/- ## ========================================= + Coverage 84.5% 88.2% +3.6% ========================================= Files 10 1165 +1155 Lines 214 50810 +50596 Branches 25 573 +548 ========================================= + Hits 181 44827 +44646 - Misses 23 5860 +5837 - Partials 10 123 +113 ``` | [Flag](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation) | Coverage Δ | | |---|---|---| | [integrationtests](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation) | `63.1% <93.7%> (?)` | | | [unittests](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation) | `86.1% <93.0%> (+1.5%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation) | Coverage Δ | | |---|---|---| | [...src/dask\_task\_models\_library/container\_tasks/io.py](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921?src=pr&el=tree&filepath=packages%2Fdask-task-models-library%2Fsrc%2Fdask_task_models_library%2Fcontainer_tasks%2Fio.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation#diff-cGFja2FnZXMvZGFzay10YXNrLW1vZGVscy1saWJyYXJ5L3NyYy9kYXNrX3Rhc2tfbW9kZWxzX2xpYnJhcnkvY29udGFpbmVyX3Rhc2tzL2lvLnB5) | `100.0% <100.0%> (ø)` | | | [...src/models\_library/api\_schemas\_catalog/services.py](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921?src=pr&el=tree&filepath=packages%2Fmodels-library%2Fsrc%2Fmodels_library%2Fapi_schemas_catalog%2Fservices.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation#diff-cGFja2FnZXMvbW9kZWxzLWxpYnJhcnkvc3JjL21vZGVsc19saWJyYXJ5L2FwaV9zY2hlbWFzX2NhdGFsb2cvc2VydmljZXMucHk=) | `100.0% <100.0%> (ø)` | | | [...s/models-library/src/models\_library/basic\_regex.py](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921?src=pr&el=tree&filepath=packages%2Fmodels-library%2Fsrc%2Fmodels_library%2Fbasic_regex.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation#diff-cGFja2FnZXMvbW9kZWxzLWxpYnJhcnkvc3JjL21vZGVsc19saWJyYXJ5L2Jhc2ljX3JlZ2V4LnB5) | `100.0% <100.0%> (ø)` | | | [...rc/models\_library/function\_services\_catalog/api.py](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921?src=pr&el=tree&filepath=packages%2Fmodels-library%2Fsrc%2Fmodels_library%2Ffunction_services_catalog%2Fapi.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation#diff-cGFja2FnZXMvbW9kZWxzLWxpYnJhcnkvc3JjL21vZGVsc19saWJyYXJ5L2Z1bmN0aW9uX3NlcnZpY2VzX2NhdGFsb2cvYXBpLnB5) | `100.0% <100.0%> (ø)` | | | [...y/function\_services\_catalog/services/demo\_units.py](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921?src=pr&el=tree&filepath=packages%2Fmodels-library%2Fsrc%2Fmodels_library%2Ffunction_services_catalog%2Fservices%2Fdemo_units.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation#diff-cGFja2FnZXMvbW9kZWxzLWxpYnJhcnkvc3JjL21vZGVsc19saWJyYXJ5L2Z1bmN0aW9uX3NlcnZpY2VzX2NhdGFsb2cvc2VydmljZXMvZGVtb191bml0cy5weQ==) | `100.0% <100.0%> (ø)` | | | [.../function\_services\_catalog/services/file\_picker.py](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921?src=pr&el=tree&filepath=packages%2Fmodels-library%2Fsrc%2Fmodels_library%2Ffunction_services_catalog%2Fservices%2Ffile_picker.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation#diff-cGFja2FnZXMvbW9kZWxzLWxpYnJhcnkvc3JjL21vZGVsc19saWJyYXJ5L2Z1bmN0aW9uX3NlcnZpY2VzX2NhdGFsb2cvc2VydmljZXMvZmlsZV9waWNrZXIucHk=) | `100.0% <100.0%> (ø)` | | | [...y/function\_services\_catalog/services/iter\_range.py](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921?src=pr&el=tree&filepath=packages%2Fmodels-library%2Fsrc%2Fmodels_library%2Ffunction_services_catalog%2Fservices%2Fiter_range.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation#diff-cGFja2FnZXMvbW9kZWxzLWxpYnJhcnkvc3JjL21vZGVsc19saWJyYXJ5L2Z1bmN0aW9uX3NlcnZpY2VzX2NhdGFsb2cvc2VydmljZXMvaXRlcl9yYW5nZS5weQ==) | `82.3% <100.0%> (ø)` | | | [...tion\_services\_catalog/services/iter\_sensitivity.py](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921?src=pr&el=tree&filepath=packages%2Fmodels-library%2Fsrc%2Fmodels_library%2Ffunction_services_catalog%2Fservices%2Fiter_sensitivity.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation#diff-cGFja2FnZXMvbW9kZWxzLWxpYnJhcnkvc3JjL21vZGVsc19saWJyYXJ5L2Z1bmN0aW9uX3NlcnZpY2VzX2NhdGFsb2cvc2VydmljZXMvaXRlcl9zZW5zaXRpdml0eS5weQ==) | `51.7% <100.0%> (ø)` | | | [.../function\_services\_catalog/services/nodes\_group.py](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921?src=pr&el=tree&filepath=packages%2Fmodels-library%2Fsrc%2Fmodels_library%2Ffunction_services_catalog%2Fservices%2Fnodes_group.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation#diff-cGFja2FnZXMvbW9kZWxzLWxpYnJhcnkvc3JjL21vZGVsc19saWJyYXJ5L2Z1bmN0aW9uX3NlcnZpY2VzX2NhdGFsb2cvc2VydmljZXMvbm9kZXNfZ3JvdXAucHk=) | `100.0% <100.0%> (ø)` | | | [...y/function\_services\_catalog/services/parameters.py](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921?src=pr&el=tree&filepath=packages%2Fmodels-library%2Fsrc%2Fmodels_library%2Ffunction_services_catalog%2Fservices%2Fparameters.py&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation#diff-cGFja2FnZXMvbW9kZWxzLWxpYnJhcnkvc3JjL21vZGVsc19saWJyYXJ5L2Z1bmN0aW9uX3NlcnZpY2VzX2NhdGFsb2cvc2VydmljZXMvcGFyYW1ldGVycy5weQ==) | `100.0% <100.0%> (ø)` | | | ... and [32 more](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation) | | ... and [1124 files with indirect coverage changes](https://app.codecov.io/gh/ITISFoundation/osparc-simcore/pull/5921/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ITISFoundation)