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

Feature/private core module #787

Merged
merged 19 commits into from
Nov 8, 2024
Merged

Conversation

mgovers
Copy link
Member

@mgovers mgovers commented Oct 15, 2024

Closes #784

Notes to reviewer:

review commit-by-commit. that's much easier

mgovers and others added 4 commits October 15, 2024 10:09
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
…re-module

Signed-off-by: Martijn Govers <martijn.govers@alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Copy link
Contributor

@figueroa1395 figueroa1395 left a comment

Choose a reason for hiding this comment

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

Reviewed 3aa2ee5. Only minor comments.

docs/examples/Validation Examples.ipynb Outdated Show resolved Hide resolved
src/power_grid_model/_core/power_grid_model.py Outdated Show resolved Hide resolved
Copy link
Contributor

@figueroa1395 figueroa1395 left a comment

Choose a reason for hiding this comment

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

Reviewed 6ca7e5c: Looks good, the only worry I have is that since this task can be very cherry-pickish (We have to cherry pick all, but still...), I hope we don't miss exposing one functionality from the core and hence break anyones workflow.

src/power_grid_model/core/__init__.py Outdated Show resolved Hide resolved
Copy link
Contributor

@figueroa1395 figueroa1395 left a comment

Choose a reason for hiding this comment

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

Reviewed ee1cdf9: All looks good, code generation check comming to the rescue here! ;)

@TonyXiang8787
Copy link
Member

Do we really need this? I propose to change it to _core immediately. No warnings, just error.

When we released PGM, we made it very clear that Python stuff which is not documented in the read the docs is not public API and not supported.

@mgovers
Copy link
Member Author

mgovers commented Oct 16, 2024

Do we really need this? I propose to change it to _core immediately. No warnings, just error.

When we released PGM, we made it very clear that Python stuff which is not documented in the read the docs is not public API and not supported.

i'm all for that but it may break users' code. i propose to remove this (temp) library at the same time when we actually do the version bump, so that users can specify that. let's discuss tomorrow @petersalemink95

mgovers and others added 4 commits October 17, 2024 08:27
…re-module

Signed-off-by: Martijn Govers <martijn.govers@alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
@mgovers mgovers added the do-not-merge This should not be merged label Oct 18, 2024
@mgovers mgovers linked an issue Oct 18, 2024 that may be closed by this pull request
4 tasks
@mgovers
Copy link
Member Author

mgovers commented Oct 18, 2024

cfr. discussions: this will be merged in the same PR that will bump the version to v1.10.0

@mgovers mgovers added the improvement Improvement on internal implementation label Oct 18, 2024
…into feature/private-core-module

Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
…into feature/private-core-module

Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
…into feature/private-core-module

Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Base automatically changed from feature/columnar-data-examples to main October 22, 2024 07:16
@mgovers mgovers mentioned this pull request Oct 22, 2024
27 tasks
mgovers and others added 6 commits October 29, 2024 10:55
…module

Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
Signed-off-by: Martijn Govers <martijn.govers@alliander.com>
…o feature/private-core-module

Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
…module

Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
@mgovers mgovers changed the base branch from main to release/v1.10.0-rc November 7, 2024 17:19
@mgovers mgovers marked this pull request as ready for review November 7, 2024 17:19
@mgovers mgovers mentioned this pull request Nov 7, 2024
3 tasks
Copy link
Contributor

@figueroa1395 figueroa1395 left a comment

Choose a reason for hiding this comment

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

Re re-ran all the examples and checked the changes again. All looks good.

…/private-core-module

Signed-off-by: Martijn Govers <Martijn.Govers@Alliander.com>
@mgovers mgovers merged commit 06952d8 into release/v1.10.0-rc Nov 8, 2024
15 of 16 checks passed
@mgovers mgovers deleted the feature/private-core-module branch November 8, 2024 10:19
Copy link

sonarqubecloud bot commented Nov 8, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do-not-merge This should not be merged improvement Improvement on internal implementation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] make python API core functionality private
4 participants