Feat/date time #21
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,49 +1,11 @@ | ||
| name: Unit Tests | ||
| on: | ||
| push: | ||
| workflow_dispatch: | ||
|
|
||
| jobs: | ||
| py_build_tests: | ||
| uses: neongeckocom/.github/.github/workflows/python_build_tests.yml@master | ||
| with: | ||
| python_version: "3.8" | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,39 +1,11 @@ | ||
| name: Run License Tests | ||
| on: | ||
| push: | ||
| workflow_dispatch: | ||
| pull_request: | ||
| branches: | ||
| - master | ||
| jobs: | ||
| license_tests: | ||
| uses: neongeckocom/.github/.github/workflows/license_tests.yml@master | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -69,4 +69,4 @@ jobs: | |
| uses: ad-m/github-push-action@master | ||
| with: | ||
| github_token: ${{ secrets.GITHUB_TOKEN }} | ||
| branch: dev | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -7,6 +7,7 @@ on: | |||||
|
|
||||||
| jobs: | ||||||
| publish_alpha: | ||||||
| if: github.event.pull_request.merged == true | ||||||
| uses: TigreGotico/gh-automations/.github/workflows/publish-alpha.yml@master | ||||||
| secrets: inherit | ||||||
| with: | ||||||
|
|
@@ -17,6 +18,22 @@ jobs: | |||||
| publish_prerelease: true | ||||||
| changelog_max_issues: 100 | ||||||
|
|
||||||
| notify: | ||||||
| if: github.event.pull_request.merged == true | ||||||
| needs: publish_alpha | ||||||
| runs-on: ubuntu-latest | ||||||
| steps: | ||||||
| - uses: actions/checkout@v2 | ||||||
|
There was a problem hiding this comment. Update actions/checkout action version. The static analysis tool has flagged that the version of the Please update the action version as follows: - - uses: actions/checkout@v2
+ - uses: actions/checkout@v3This change will ensure you're using the most up-to-date version of the checkout action. 📝 Committable suggestion
Suggested change
🧰 Tools🪛 actionlint
|
||||||
| - name: Send message to Matrix bots channel | ||||||
| id: matrix-chat-message | ||||||
| uses: fadenb/[email protected] | ||||||
| with: | ||||||
| homeserver: 'matrix.org' | ||||||
| token: ${{ secrets.MATRIX_TOKEN }} | ||||||
| channel: '!WjxEKjjINpyBRPFgxl:krbel.duckdns.org' | ||||||
| message: | | ||||||
| new ${{ github.event.repository.name }} PR merged! https://github.com/${{ github.repository }}/pull/${{ github.event.number }} | ||||||
|
|
||||||
| publish_pypi: | ||||||
| needs: publish_alpha | ||||||
| if: success() # Ensure this job only runs if the previous job succeeds | ||||||
|
|
@@ -36,20 +53,6 @@ jobs: | |||||
| - name: version | ||||||
| run: echo "::set-output name=version::$(python setup.py --version)" | ||||||
| id: version | ||||||
| - name: Build Distribution Packages | ||||||
| run: | | ||||||
| python setup.py sdist bdist_wheel | ||||||
|
|
@@ -102,4 +105,3 @@ jobs: | |||||
| -H "Authorization: token $GITHUB_TOKEN" \ | ||||||
| -d "{\"title\":\"$PR_TITLE\",\"body\":\"$PR_BODY\",\"head\":\"$HEAD_BRANCH\",\"base\":\"$BASE_BRANCH\"}" \ | ||||||
| https://api.github.com/repos/${{ github.repository }}/pulls | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -142,15 +142,19 @@ def __init__(self, serial, bus, size=16): | |
| self.start() | ||
|
|
||
| def flush(self): | ||
| LOG.debug(f"alive in flush {self.is_alive}") | ||
| while self.alive: | ||
| try: | ||
| cmd = self.commands.get() + '\n' | ||
| LOG.debug(f"in arduino.flush {cmd}") | ||
| self.serial.write(cmd.encode()) | ||
| self.commands.task_done() | ||
| except Exception as e: | ||
| LOG.error("Writing error: {0}".format(e)) | ||
| LOG.debug("not alive anymore") | ||
|
|
||
| def write(self, command): | ||
| LOG.debug(f"command in writer write {command}") | ||
| self.commands.put(str(command)) | ||
|
|
||
| def stop(self): | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| """ | ||
| on merge to master -> declare stable (remove alpha) | ||
| """ | ||
| import argparse | ||
| import fileinput | ||
| from os.path import abspath | ||
|
|
||
|
|
||
| def update_alpha(version_file): | ||
| alpha_var_name = "VERSION_ALPHA" | ||
|
|
||
| for line in fileinput.input(version_file, inplace=True): | ||
| if line.startswith(alpha_var_name): | ||
| print(f"{alpha_var_name} = 0") | ||
| else: | ||
| print(line.rstrip('\n')) | ||
|
Comment on lines
+9
to
+16
There was a problem hiding this comment. 🛠️ Refactor suggestion Improve error handling and add feedback in The function correctly modifies the file, but it lacks error handling and doesn't provide feedback. Consider the following improvements:
Here's a suggested improvement: def update_alpha(version_file):
alpha_var_name = "VERSION_ALPHA"
modified = False
try:
with fileinput.input(version_file, inplace=True) as file:
for line in file:
if line.startswith(alpha_var_name):
print(f"{alpha_var_name} = 0")
modified = True
else:
print(line.rstrip('\n'))
if not modified:
print(f"Warning: {alpha_var_name} not found in {version_file}")
else:
print(f"Successfully updated {version_file}")
except IOError as e:
print(f"Error updating {version_file}: {e}")
raise
return modifiedThis version adds error handling, provides feedback, and returns a boolean indicating whether the file was modified. |
||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| parser = argparse.ArgumentParser( | ||
| description='Update the version based on the specified part (major, minor, build, alpha)') | ||
| parser.add_argument('--version-file', help='Path to the version.py file', required=True) | ||
|
|
||
| args = parser.parse_args() | ||
|
|
||
| update_alpha(abspath(args.version_file)) | ||
|
Comment on lines
+19
to
+26
There was a problem hiding this comment. 🛠️ Refactor suggestion Enhance main block with error handling and user feedback The main block correctly sets up argparse and calls the
Here's a suggested improvement: if __name__ == "__main__":
parser = argparse.ArgumentParser(
description='Remove alpha designation from the version file by setting VERSION_ALPHA to 0')
parser.add_argument('--version-file',
help='Path to the version.py file to be updated',
required=True)
args = parser.parse_args()
try:
version_file = abspath(args.version_file)
if update_alpha(version_file):
print(f"Successfully removed alpha designation in {version_file}")
else:
print(f"No changes were made to {version_file}")
except Exception as e:
print(f"Error: Failed to update {args.version_file}")
print(f"Reason: {str(e)}")
exit(1)This version adds error handling, provides clear user feedback, and uses a more descriptive help message for the --version-file argument. |
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| """ | ||
| on merge to dev: | ||
| - depending on labels (conventional commits) script is called with "major", "minor", "build", "alpha" | ||
| - on merge to dev, update version.py string to enforce semver | ||
| """ | ||
|
|
||
| import argparse | ||
| from os.path import abspath | ||
|
|
||
| def read_version(version_file): | ||
| VERSION_MAJOR = 0 | ||
| VERSION_MINOR = 0 | ||
| VERSION_BUILD = 0 | ||
| VERSION_ALPHA = 0 | ||
|
|
||
| with open(version_file, 'r') as file: | ||
| content = file.read() | ||
| for l in content.split("\n"): | ||
| l = l.strip() | ||
| if l.startswith("VERSION_MAJOR"): | ||
| VERSION_MAJOR = int(l.split("=")[-1]) | ||
| elif l.startswith("VERSION_MINOR"): | ||
| VERSION_MINOR = int(l.split("=")[-1]) | ||
| elif l.startswith("VERSION_BUILD"): | ||
| VERSION_BUILD = int(l.split("=")[-1]) | ||
| elif l.startswith("VERSION_ALPHA"): | ||
| VERSION_ALPHA = int(l.split("=")[-1]) | ||
| return VERSION_MAJOR, VERSION_MINOR, VERSION_BUILD, VERSION_ALPHA | ||
|
Comment on lines
+10
to
+28
There was a problem hiding this comment. 🛠️ Refactor suggestion Improve readability and robustness of The function logic is correct, but there are a few areas for improvement:
Here's a suggested refactoring: import re
def read_version(version_file):
version_components = {
"VERSION_MAJOR": 0,
"VERSION_MINOR": 0,
"VERSION_BUILD": 0,
"VERSION_ALPHA": 0
}
pattern = re.compile(r'^(VERSION_[A-Z]+)\s*=\s*(\d+)')
with open(version_file, 'r') as file:
for line in file:
match = pattern.match(line.strip())
if match:
key, value = match.groups()
if key in version_components:
version_components[key] = int(value)
return tuple(version_components.values())This refactoring improves readability, uses a more robust parsing method, and maintains the original function signature. 🧰 Tools🪛 Ruff
|
||
|
|
||
|
|
||
| def update_version(part, version_file): | ||
| VERSION_MAJOR, VERSION_MINOR, VERSION_BUILD, VERSION_ALPHA = read_version(version_file) | ||
|
|
||
| if part == 'major': | ||
| VERSION_MAJOR += 1 | ||
| VERSION_MINOR = 0 | ||
| VERSION_BUILD = 0 | ||
| VERSION_ALPHA = 1 | ||
| elif part == 'minor': | ||
| VERSION_MINOR += 1 | ||
| VERSION_BUILD = 0 | ||
| VERSION_ALPHA = 1 | ||
| elif part == 'build': | ||
| VERSION_BUILD += 1 | ||
| VERSION_ALPHA = 1 | ||
| elif part == 'alpha': | ||
| VERSION_ALPHA += 1 | ||
|
|
||
| with open(version_file, 'w') as file: | ||
| file.write(f"""# START_VERSION_BLOCK | ||
| VERSION_MAJOR = {VERSION_MAJOR} | ||
| VERSION_MINOR = {VERSION_MINOR} | ||
| VERSION_BUILD = {VERSION_BUILD} | ||
| VERSION_ALPHA = {VERSION_ALPHA} | ||
| # END_VERSION_BLOCK""") | ||
|
Comment on lines
+31
to
+55
There was a problem hiding this comment. 🛠️ Refactor suggestion Enhance robustness and maintainability of The function correctly implements semantic versioning logic, but there are opportunities for improvement:
Here's a suggested refactoring: from enum import Enum
import re
class VersionPart(Enum):
MAJOR = 'major'
MINOR = 'minor'
BUILD = 'build'
ALPHA = 'alpha'
def update_version(part: VersionPart, version_file: str):
try:
VERSION_MAJOR, VERSION_MINOR, VERSION_BUILD, VERSION_ALPHA = read_version(version_file)
if part == VersionPart.MAJOR:
VERSION_MAJOR += 1
VERSION_MINOR = VERSION_BUILD = 0
VERSION_ALPHA = 1
elif part == VersionPart.MINOR:
VERSION_MINOR += 1
VERSION_BUILD = 0
VERSION_ALPHA = 1
elif part == VersionPart.BUILD:
VERSION_BUILD += 1
VERSION_ALPHA = 1
elif part == VersionPart.ALPHA:
VERSION_ALPHA += 1
version_block = f"""# START_VERSION_BLOCK
VERSION_MAJOR = {VERSION_MAJOR}
VERSION_MINOR = {VERSION_MINOR}
VERSION_BUILD = {VERSION_BUILD}
VERSION_ALPHA = {VERSION_ALPHA}
# END_VERSION_BLOCK"""
with open(version_file, 'r+') as file:
content = file.read()
file.seek(0)
file.write(re.sub(r'# START_VERSION_BLOCK.*# END_VERSION_BLOCK', version_block, content, flags=re.DOTALL))
file.truncate()
except IOError as e:
print(f"Error updating version file: {e}")
raiseThis refactoring adds error handling, preserves other file content, and uses an enum for version parts to improve maintainability. |
||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| parser = argparse.ArgumentParser(description='Update the version based on the specified part (major, minor, build, alpha)') | ||
| parser.add_argument('part', help='Part of the version to update (major, minor, build, alpha)') | ||
| parser.add_argument('--version-file', help='Path to the version.py file', required=True) | ||
|
|
||
| args = parser.parse_args() | ||
|
|
||
| update_version(args.part, abspath(args.version_file)) | ||
|
Comment on lines
+58
to
+65
There was a problem hiding this comment. 🛠️ Refactor suggestion Add error handling to the main execution block. The argument parsing is implemented correctly, but there's room for improvement:
Here's a suggested improvement: if __name__ == "__main__":
parser = argparse.ArgumentParser(description='Update the version based on the specified part (major, minor, build, alpha)')
parser.add_argument('part', choices=['major', 'minor', 'build', 'alpha'], help='Part of the version to update')
parser.add_argument('--version-file', help='Path to the version.py file', required=True)
args = parser.parse_args()
try:
update_version(VersionPart(args.part), abspath(args.version_file))
print(f"Successfully updated {args.part} version in {args.version_file}")
except Exception as e:
print(f"Error updating version: {e}")
exit(1)This improvement adds error handling and validates the |
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # START_VERSION_BLOCK | ||
| VERSION_MAJOR = 0 | ||
| VERSION_MINOR = 0 | ||
| VERSION_BUILD = 0 | ||
| VERSION_ALPHA = 1 | ||
| # END_VERSION_BLOCK |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Reconsider Python version coverage.
A previous review suggested including Python 3.11 in the test matrix. While the current implementation has moved away from a matrix approach, it's worth reconsidering the Python versions you're testing against.
If your project supports multiple Python versions, consider updating the workflow to test against them:
This ensures compatibility across supported Python versions, including the latest stable release (3.11).