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

Rename rez.vendor.version to rez.version and define a public API for rez.version #1534

Conversation

JeanChristopheMorinPerso
Copy link
Member

@JeanChristopheMorinPerso JeanChristopheMorinPerso commented Sep 16, 2023

Implements #1484.

This PR renames/moves rez.vendor.version out of the vendor folder into its new home, rez.version. This makes it a first class citizen.

Changes

  • rez.vendor.version moved to rez.version
  • All its submodules are now private:
    • rez.vendor.version.version renamed to rez.version._version
    • rez.vendor.version.util renamed to rez.version._util
    • rez.vendor.version.requirement renamed to rez.version._requirement
  • rez.version re-exports all classes and functions that are public
  • Some functions that were previously public are now private:
    • rez.vendor.version.util.dedup
  • Added a deprecation warning in rez.vendor.version that loks like this:
    (.venv) [jcmorin@arch01 rez]$ python -c 'import rez.vendor.version'
    <string>:1: DeprecationWarning: module 'rez.vendor.version' is deprecated and will be removed in 3.0.0. Use 'rez.version' instead.
    

Notes

#1562 should be merged before so that we can use rez.deprecations.

TODOs

  • Properly document (unify all module docstrings into rez.version).
  • Update docstrings to be valid Sphinx docstrings.

…et. Only the minimum amount of changes required to run the version tests.

Signed-off-by: Jean-Christophe Morin <[email protected]>
Signed-off-by: Jean-Christophe Morin <[email protected]>
Signed-off-by: Jean-Christophe Morin <[email protected]>
Signed-off-by: Jean-Christophe Morin <[email protected]>
Signed-off-by: Jean-Christophe Morin <[email protected]>
Signed-off-by: Jean-Christophe Morin <[email protected]>
Signed-off-by: Jean-Christophe Morin <[email protected]>
Signed-off-by: Jean-Christophe Morin <[email protected]>
Signed-off-by: Jean-Christophe Morin <[email protected]>
@JeanChristopheMorinPerso JeanChristopheMorinPerso merged commit c6a200c into AcademySoftwareFoundation:main Nov 24, 2023
28 checks passed
@JeanChristopheMorinPerso JeanChristopheMorinPerso deleted the move_version_module branch November 24, 2023 00:58
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.

1 participant