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

robotlibcore.py placed right into root of site-packages/ #149

Closed
rasjani opened this issue May 15, 2024 · 5 comments
Closed

robotlibcore.py placed right into root of site-packages/ #149

rasjani opened this issue May 15, 2024 · 5 comments
Labels
acknowledge To be acknowledged in release notes enhancement priority: high

Comments

@rasjani
Copy link
Contributor

rasjani commented May 15, 2024

Would be a bit more cleaner if placed into it's own subdirectory inside site-packages. While the file is probably never going to clash with anything - just for hygiene's sake ?

@aaltat
Copy link
Contributor

aaltat commented May 16, 2024

I have tough the same thing, because the single file is getting pretty big and would benefit from splitting smaller pieces. But it didn’t bother me enough that I would have done something about it. Do you want to give it a go?

@rasjani
Copy link
Contributor Author

rasjani commented May 16, 2024

Currently i do have some wip that moves the src/robotlibcore.py into src/robotlibcore/__init__.py and changes to setup.py to build the sdist/wheels so that nothing is placed into root.. all utests and atests do pass with this setup.

  1. i dont like to have everything on __init__.py
  2. I don't have any major feelings on how to do the split.
  3. If code is split up, can i rely on atests that all the stuff that should be exported from __init__.py will get exported and not get regressions ? This also has the downside of having to manually give the dunder init up to date if/when there's changes what should and should get exposed ..

But in general, if you have any guidelines on what you would like to split, i can take a stab. However, I'd prefer to only do the shuffling part and not change any inheritance like mentioned in issue #1

@aaltat
Copy link
Contributor

aaltat commented May 16, 2024

  1. Agree, it moves the problem to new file.
  2. I never gave it much thinking how do to the split. Perhaps by splitting hybrid core methods in one place and dynamic core stuff in other file. And perhaps keyword builder also in separate file.
  3. I think you can do something with all https://docs.python.org/3/tutorial/modules.html#importing-from-a-package

@aaltat
Copy link
Contributor

aaltat commented May 16, 2024

And doing only the shuffling part is also good way to go.

@rasjani
Copy link
Contributor Author

rasjani commented May 16, 2024

#150 -- first pick .. Just point out what you what you what changed.

rasjani added a commit to rasjani/PythonLibCore that referenced this issue May 17, 2024
pr splits robotlibcore.py into smaller source files to rework packaging
to be placed into directory inside site-packages instead of single file
into root of site-packages

Fixes robotframework#149
@aaltat aaltat closed this as completed in c035a37 May 17, 2024
@aaltat aaltat added the acknowledge To be acknowledged in release notes label May 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
acknowledge To be acknowledged in release notes enhancement priority: high
Projects
None yet
Development

No branches or pull requests

2 participants