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

Add checks for correct semantic version of Python #176

Open
wants to merge 12 commits into
base: develop
Choose a base branch
from
Open

Add checks for correct semantic version of Python #176

wants to merge 12 commits into from

Conversation

michaelsaki
Copy link
Collaborator

@michaelsaki michaelsaki commented Mar 20, 2024 •
edited by jsf9k

🗣 Description

Now if a user enters an incorrect semantic version of Python they will get the following message:
"Invalid version of Python: Python follows semantic versioning, so any version string that is not a valid semantic version is an invalid version of Python."

💭 Motivation and context

This PR will address the issue here: #167.

🧪 Testing

I tested this by making a testing script that verified the following examples were valid or invalid semantic versions:

Valid Semantic Versions

0.0.4
1.2.3
10.20.30
1.1.2-prerelease+meta
1.1.2+meta
1.1.2+meta-valid
1.0.0-alpha
1.0.0-beta
1.0.0-alpha.beta
1.0.0-alpha.beta.1
1.0.0-alpha.1
1.0.0-alpha0.valid
1.0.0-alpha.0valid
1.0.0-alpha-a.b-c-somethinglong+build.1-aef.1-its-okay
1.0.0-rc.1+build.1
2.0.0-rc.1+build.123
1.2.3-beta
10.2.3-DEV-SNAPSHOT
1.2.3-SNAPSHOT-123
1.0.0
2.0.0
1.1.7
2.0.0+build.1848
2.0.1-alpha.1227
1.0.0-alpha+beta
1.2.3----RC-SNAPSHOT.12.9.1--.12+788
1.2.3----R-S.12.9.1--.12+meta
1.2.3----RC-SNAPSHOT.12.9.1--.12
1.0.0+0.build.1-rc.10000aaa-kk-0.1
99999999999999999999999.999999999999999999.99999999999999999
1.0.0-0A.is.legal

Invalid Semantic Versions

1
1.2
1.2.3-0123
1.2.3-0123.0123
1.1.2+.123
+invalid
-invalid
-invalid+invalid
-invalid.01
alpha
alpha.beta
alpha.beta.1
alpha.1
alpha+beta
alpha_beta
alpha.
alpha..
beta
1.0.0-alpha_beta
-alpha.
1.0.0-alpha..
1.0.0-alpha..1
1.0.0-alpha...1
1.0.0-alpha....1
1.0.0-alpha.....1
1.0.0-alpha......1
1.0.0-alpha.......1
01.1.1
1.01.1
1.1.01
1.2
1.2.3.DEV
1.2-SNAPSHOT
1.2.31.2.3----RC-SNAPSHOT.12.09.1--..12+788
1.2-RC-SNAPSHOT
-1.0.3-gamma+b7718
+justmeta
9.8.7+meta+meta
9.8.7-whatever+meta+meta
99999999999999999999999.999999999999999999.99999999999999999----RC-SNAPSHOT.12.09.1--------------------------------..12

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • Changes are limited to a single goal - eschew scope creep!
  • All relevant type-of-change labels have been added.
  • I have read the CONTRIBUTING document.
  • These code changes follow cisagov code standards.
  • All new and existing tests pass.

✅ Pre-merge checklist

  • Revert dependencies to default branches.
  • Finalize version.

✅ Post-merge checklist

  • Create a release.

Michael Saki added 8 commits February 14, 2024 12:59
Add checks for semantic python versions
33582a1
Refactor code for the semantic check
9438194 
This commit will make a few changes. The
orginal version of the semantic checking
function was a bit more difficult to read.
It is now somewhat easier to follow how
the regex is structured. Also the function
has been renamed to check_python_version
since it has 2 functions, making sure that
the version is semantically correct and the
second is to make sure that it is installed
on the user's machine. This makes it easier
to follow the logic for the flags, -p or
--python-version and -l or --list-versions
Add checks for semantic python versions
cea8edc
Refactor code for the semantic check
d5c7c4a 
This commit will make a few changes. The
orginal version of the semantic checking
function was a bit more difficult to read.
It is now somewhat easier to follow how
the regex is structured. Also the function
has been renamed to check_python_version
since it has 2 functions, making sure that
the version is semantically correct and the
second is to make sure that it is installed
on the user's machine. This makes it easier
to follow the logic for the flags, -p or
--python-version and -l or --list-versions
Merge branch 'improvement/correct-semantic-python-version-checks' of h…
f7b9d05 
…ttps://github.com/cisagov/skeleton-generic into improvement/correct-semantic-python-version-checks
Remove example of correct semantic version
327ab73
Refactor the error message for the user
4dedf50
Improve the semantic error message
e84deea
@michaelsaki michaelsaki added the improvement This issue or pull request will add or improve functionality, maintainability, or ease of use label Mar 20, 2024
@michaelsaki michaelsaki linked an issue Mar 20, 2024 that may be closed by this pull request
setup-env should check that Python version is a valid semantic version #167
Open
dav3r
dav3r approved these changes Mar 20, 2024
View reviewed changes
Copy link
Member

@dav3r dav3r left a comment

Choose a reason for hiding this comment

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

Looks good to my eyes. 👍

I requested one comment be added and one small grammatical change to another comment.

setup-env Outdated Show resolved Hide resolved
setup-env Show resolved Hide resolved
michaelsaki and others added 2 commits March 20, 2024 15:39
@michaelsaki @dav3r
Fix grammar
5fdc7be 
Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Refactor regex, add link, and improve comments
42ef8c2
jsf9k
jsf9k requested changes Mar 21, 2024
View reviewed changes
setup-env Outdated Show resolved Hide resolved
dav3r
dav3r reviewed Mar 21, 2024
View reviewed changes
setup-env Outdated Show resolved Hide resolved
@michaelsaki @dav3r
Remove unnecessary period
5fe14c7 
Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dav3r dav3r dav3r approved these changes

@jsf9k jsf9k jsf9k approved these changes

@felddy felddy Awaiting requested review from felddy felddy is a code owner

@jasonodoom jasonodoom Awaiting requested review from jasonodoom jasonodoom is a code owner

@mcdonnnj mcdonnnj Awaiting requested review from mcdonnnj mcdonnnj is a code owner

Assignees
No one assigned
Labels
improvement This issue or pull request will add or improve functionality, maintainability, or ease of use
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

setup-env should check that Python version is a valid semantic version
3 participants
@michaelsaki @jsf9k @dav3r