Skip to content
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

Updated core model to version with required keywords and docstrings #1864

Merged
merged 7 commits into from
Jul 25, 2024

Conversation

doctrino
Copy link
Contributor

@doctrino doctrino commented Jul 25, 2024

Description

  • The core model itself is not updated but the code for generating it has changed.
    • Required keyword args
    • Docstrings
    • Snake caseing of words with 3D correctly: object_3d instead of object_3_d
  • Added the script for generating the core model. Note I did not add a CICD as there are a few manual changes that is required and linting to run for the output of the generator to match exactly what is committed to history.

Checklist:

  • Tests added/updated.
  • Documentation updated. Documentation is generated from docstrings - these must be updated according to your change.
    If a new method has been added it should be referenced in cognite.rst in order to generate docs based on its docstring.
  • Changelog updated in CHANGELOG.md.
  • Version bumped. If triggering a new release is desired, bump the version number in _version.py and pyproject.toml per semantic versioning.

Copy link

codecov bot commented Jul 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.06%. Comparing base (c05587f) to head (83af39e).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1864      +/-   ##
==========================================
- Coverage   91.06%   91.06%   -0.01%     
==========================================
  Files         124      124              
  Lines       19245    19245              
==========================================
- Hits        17526    17525       -1     
- Misses       1719     1720       +1     
Files Coverage Δ
cognite/client/_version.py 100.00% <100.00%> (ø)
cognite/client/data_classes/cdm/__init__.py 100.00% <100.00%> (ø)
cognite/client/data_classes/cdm/v1.py 55.44% <ø> (-0.12%) ⬇️

... and 2 files with indirect coverage changes

@doctrino doctrino marked this pull request as ready for review July 25, 2024 13:23
@doctrino doctrino requested review from a team as code owners July 25, 2024 13:23
@doctrino doctrino requested review from roligheten and removed request for a team July 25, 2024 13:23
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is sweet!

CHANGELOG.md Outdated
Comment on lines 24 to 25


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

Comment on lines 23 to 24
class CogniteDescribableNodeApply(CogniteDescribableProperties, TypedNodeApply):
"""This represents the writing format of cognite describable node.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Quite a lot of lower-cased cognite:

Suggested change
class CogniteDescribableNodeApply(CogniteDescribableProperties, TypedNodeApply):
"""This represents the writing format of cognite describable node.
class CogniteDescribableNodeApply(CogniteDescribableProperties, TypedNodeApply):
"""This represents the writing format of Cognite describable node.

Comment on lines +67 to +68


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

Comment on lines +4609 to +4610


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change

@haakonvt haakonvt changed the title Updated core model to version with required keywords and docstrtings Updated core model to version with required keywords and docstrings Jul 25, 2024
@doctrino doctrino requested a review from haakonvt July 25, 2024 13:46
@doctrino doctrino merged commit 91c82e6 into master Jul 25, 2024
13 checks passed
@doctrino doctrino deleted the update-core-model branch July 25, 2024 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants