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.

Sign up for GitHub

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

Jump to bottom

Custom profile #20

Merged
merged 16 commits into from
Oct 11, 2023
Merged

Custom profile #20

merged 16 commits into from
Oct 11, 2023

Conversation

guillaume-alliander
Copy link
Collaborator

  • Add clean custom profile via the BaseProfile class
  • document use of customprofile
  • reorganise Base.py which had a lot of things into a utils package and neatly separated modules.
  • piggyback: remove all imports from init - it shaves 4s on start, thanks to not having to load all resources in memory
  • piggyback: unit test to check the syntax/validity of all resources

chicco785
chicco785 reviewed Oct 5, 2023
View reviewed changes
Copy link
Contributor

@chicco785 chicco785 left a comment

Choose a reason for hiding this comment

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

I am not sure how namespaces are handled for the profiles and hence for the custom classes.

My assumption is that if I create a custom class, I should be able to define it's namespace. Then any attribute attached (if not specified otherwise), should use that namespace as default.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md
```python
from pycgmes.utils.profile import BaseProfile

class CustomProfile(BaseProfile):
Copy link
Contributor

Choose a reason for hiding this comment

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

I have been thinking about this (e.g. using string enums for profiles), in general I think this a bit a workaround currently, since they are used to define the short name of the profile, which is in general "arbitrary", while what matters from a semantic point of view is the fullname defined via the namespace.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

You are totally correct! I will look into that.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
examples/custom_attributes.py Show resolved Hide resolved
@guillaume-alliander guillaume-alliander force-pushed the custom_profile branch 2 times, most recently from 0b124b7 to 887bfba Compare October 6, 2023 15:58
chicco785
chicco785 reviewed Oct 7, 2023
View reviewed changes
pycgmes/utils/base.py Outdated Show resolved Hide resolved
chicco785
chicco785 approved these changes Oct 9, 2023
View reviewed changes
Copy link
Contributor

@chicco785 chicco785 left a comment

Choose a reason for hiding this comment

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

LGTM

@guillaume-alliander
Squash all previous commits for open-sourcing v1.0
a96541b 
Signed-off-by: Guillaume Roger <guillaume.roger@alliander.com>
@guillaume-alliander
Roadmap update: add readthedoc
36c2639 
Signed-off-by: Guillaume Roger <guillaume.roger@alliander.com>
@guillaume-alliander
Splitting Base.py in multiple files
5c25096 
Signed-off-by: Guillaume Roger <guillaume.roger@alliander.com>
@guillaume-alliander
using the new utils in the resources
267a25c 
Signed-off-by: Guillaume Roger <guillaume.roger@alliander.com>
@guillaume-alliander
Doc and test of custom profile
fc25e85 
Signed-off-by: Guillaume Roger <guillaume.roger@alliander.com>
@guillaume-alliander
Piggyback: fix dependabot vulnerabilities
2350176 
Signed-off-by: Guillaume Roger <guillaume.roger@alliander.com>
@guillaume-alliander
Remove fun but overkill callable module shortcut
205581c 
Signed-off-by: Guillaume Roger <guillaume.roger@alliander.com>
@guillaume-alliander
Adding licence headers
1d6cd69 
Signed-off-by: Guillaume Roger <guillaume.roger@alliander.com>
@guillaume-alliander
Version bump
4a5852b 
Signed-off-by: Guillaume Roger <guillaume.roger@alliander.com>
@guillaume-alliander
Better doc after PR
de85855 
Signed-off-by: Guillaume Roger <guillaume.roger@alliander.com>
@guillaume-alliander
Add resource namespace, and handle attribute NS properly
cb86508 
Signed-off-by: Guillaume Roger <guillaume.roger@alliander.com>
@guillaume-alliander
Namesapces should uses full string. Prefixes are a presentation thing…
aba36f0 
…, to be dealt with elsewhere.

Signed-off-by: Guillaume Roger <guillaume.roger@alliander.com>
@guillaume-alliander
chores: fix dependabot security issues
8832957 
Signed-off-by: Guillaume Roger <guillaume.roger@alliander.com>
robinklaassen and others added 3 commits October 11, 2023 16:37
@robinklaassen @guillaume-alliander
update docs with CGMES info
63e59bb 
Signed-off-by: Robin Klaassen <robin.klaassen@alliander.com>
@robinklaassen @guillaume-alliander
fix line breaking
c1cefff 
Signed-off-by: Robin Klaassen <robin.klaassen@alliander.com>
@guillaume-alliander
Intro added - remove from Roadmap
9c37797 
Signed-off-by: Guillaume Roger <guillaume.roger@alliander.com>
chicco785
chicco785 reviewed Oct 11, 2023
View reviewed changes
README.md

- [cgmes-python](#cgmes-python)
<<<<<<< HEAD
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
<<<<<<< HEAD

chicco785
chicco785 reviewed Oct 11, 2023
View reviewed changes
README.md
- [V3 source zip](#v3-source-zip)
- [Dataclasses](#dataclasses)
- [Library build, CI, CD...](#library-build-ci-cd)
- [CI](#ci)
- [CD](#cd)
- [License](#license)
>>>>>>> 4384d02 (update docs with CGMES info)
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
>>>>>>> 4384d02 (update docs with CGMES info)

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

🤦‍♂️

@guillaume-alliander guillaume-alliander merged commit 7b3d449 into main Oct 11, 2023
2 checks passed
@guillaume-alliander guillaume-alliander deleted the custom_profile branch October 11, 2023 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@chicco785 chicco785 chicco785 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@guillaume-alliander @chicco785 @robinklaassen