Merge pull request #4 from lestex/redo-imports

redo package imports and documentation

Author: lestex

.github/workflows/lint.yml

@@ -24,19 +24,16 @@ jobs:
     - name: Install dependencies
       run: |
         pip install --upgrade pip setuptools wheel
-        pip install flake8==4.0.1
-        pip install --upgrade isort blue mypy types-PyYAML bandit safety
+        pip install --upgrade isort blue mypy ruff bandit safety
 
     - name: Run lint
       run: isort .
 
     - name: Run blue formatter
       run: make format
 
-    - name: Run flake8
-      run: |
-        flake8 . --count --show-source --statistics
-        flake8 . --count --exit-zero --max-complexity=4
+    - name: Run ruff
+      run: ruff .
 
     - name: Run mypy / static types
       run: make static-check

.pre-commit-config.yaml

@@ -1,8 +1,7 @@
 # See https://pre-commit.com for more information
-# See https://pre-commit.com/hooks.html for more hooks
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.3.0
+  rev: v4.4.0
   hooks:
   - id: check-added-large-files
   - id: check-toml
@@ -21,3 +20,8 @@ repos:
   hooks:
     - id: blue
       name: blue
+- repo: https://github.com/charliermarsh/ruff-pre-commit
+  rev: v0.0.219
+  hooks:
+    - id: ruff
+      args: ["--force-exclude"]

Makefile

@@ -72,7 +72,7 @@ format: isort ## formats python
 	@blue .
 
 lint: format ## run python flake8 linter tool
-	@flake8 --exclude .git,.venv pygithubactions
+	@ruff .
 
 static-check: ## runs static checks with mypy
 	@mypy pygithubactions

README.md

@@ -7,7 +7,7 @@
 ### Import the package
 
 ```python
-import pygithubaction.core
+from pygithubactions import core
 ```
 
 ### Inputs/Outputs
@@ -17,89 +17,86 @@ Action inputs can be read with `get_input` which returns a `str` or `get_boolean
 Outputs can be set with `set_output` which makes them available to be mapped into inputs of other actions to ensure they are decoupled.
 
 ```python
-from pygithubaction.core import get_input
-from pygithubaction.core import set_output
+from pygithubactions import core
 
-my_input = get_input('inputName', required=True);
-boolean_input = get_boolean_input('booleanInputName', required=True);
-multiline_input = get_multiline_input('multilineInputName', required=True)
+my_input = core.get_input('inputName', required=True)
+boolean_input = core.get_boolean_input('booleanInputName', required=True)
+multiline_input = core.get_multiline_input('multilineInputName', required=True)
 
-set_output('outputkey', 'outputval')
+core.set_output('outputkey', 'outputval')
 ```
 
 ### Exporting variables
 
 Since each step runs in a separate process, you can use `export_variable` to add it to this step and future steps environment blocks.
 
 ```python
-from pygithubaction.core import export_variable
+from pygithubactions import core
 
-export_variable('envvar', 'val')
+core.export_variable('envvar', 'val')
 ```
 
 ### Setting a secret
 
 Setting a secret registers the secret with the runner to ensure it is masked in logs.
 
 ```python
-from pygithubaction.core import set_secret
+from pygithubactions import core
 
-set_secret('mypassword')
+core.set_secret('mypassword')
 ```
 
 ### PATH Manipulation
 
 To make a tool's path available in the path for the remainder of the job (without altering the machine or containers state), use `add_path`.  The runner will prepend the path given to the jobs PATH.
 
 ```python
-from pygithubaction.core import add_path
+from pygithubactions import core
 
-add_path('/path/to/mytool')
+core.add_path('/path/to/mytool')
 ```
 
 ### Exit codes
 
 You should use this library to set the failing exit code for your action.  If status is not set and the script runs to completion, that will lead to a success.
 
 ```python
-from pygithubaction.core import set_failed
+from pygithubactions import core
 
 try:
     # Do stuff
     # ...
 
 except Exception as e:
     # set_failed logs the message and sets a failing exit code
-    set_failed(f'Action failed with error {e}')
+    core.set_failed(f'Action failed with error {e}')
 ```
 
 ### Logging
 
 Finally, this library provides some utilities for logging. Note that debug logging is hidden from the logs by default. This behavior can be toggled by enabling the [Step Debug Logs](../../docs/action-debugging.md#step-debug-logs).
 
 ```python
-from pygithubaction.core import (
-    get_input, debug, info, notice, is_debug, error
-)
+from pygithubactions import core
 
 
-my_input = get_input('input');
+my_input = core.get_input('input')
 
 try:
-    debug('Inside try block')
-  
+    core.debug('Inside try block')
+
     if not my_input:
-        warning('my_input was not set')
-  
-    if is_debug():
-        # curl -v https://github.com
+        core.warning('my_input was not set')
+
+    if core.is_debug():
+        # do something
     else:
-        # curl https://github.com
+        # do something
 
     # Do stuff
-    info('Output to the actions build log')
-    notice('This is a message that will also emit an annotation')
+    core.info('Output to the actions build log')
+    core.notice('This is a message that will also emit an annotation')
 
 except Exception as e:
-    error(f'Error: {e}, action may still succeed though')
+    core.error(f'Error: {e}, action may still succeed though')
 ```

pygithubactions/__init__.py

@@ -0,0 +1 @@
+from pygithubactions.core import core

pygithubactions/core/core.py

@@ -64,7 +64,7 @@ def get_input(
 
     Returns:
         value (str): - Input value.
-    """   # noqa
+    """
     norm_name = name.replace(' ', '_').upper()
     value = os.environ.get(f'INPUT_{norm_name}', '')
 
@@ -91,7 +91,7 @@ def get_boolean_input(
 
     Returns:
         bool
-    """  # noqa
+    """
     true_values = ['true', 'True', 'TRUE']
     false_values = ['false', 'False', 'FALSE']
     value = get_input(name, required, trim_whitespace)
@@ -122,14 +122,14 @@ def get_multiline_input(
 
     Returns:
         list[str]: List of inputs.
-    """  # noqa
+    """
     inputs = get_input(name, required, trim_whitespace)
     inputs_list = [i for i in inputs.split('\n') if i != '']
 
     if not trim_whitespace:
         return inputs_list
 
-    return list(map(lambda i: i.strip(), inputs_list))
+    return [i.strip() for i in inputs_list]
 
 
 def set_output(name: str, value: Any) -> None:

pygithubactions/core/file_command.py

@@ -40,4 +40,4 @@ def prepare_key_value_message(key: str, value: Any) -> str:
             f'the delimiter: {delimiter}'
         )
 
-    return f'{key}<<{delimiter}{os.linesep}{converted_value}{os.linesep}{delimiter}'   # noqa
+    return f'{key}<<{delimiter}{os.linesep}{converted_value}{os.linesep}{delimiter}'

pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 
 name = "pygithubactions"
-version = "0.1.0" 
+version = "0.1.0"
 description = "Github actions core library implemented in python"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -46,3 +46,19 @@ multi_line_output = 3
 
 [tool.mypy]
 ignore_missing_imports = true
+
+[tool.ruff]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "C",  # flake8-comprehensions
+    "B",  # flake8-bugbear
+]
+
+[tool.ruff.per-file-ignores]
+"__init__.py" = ["F401"]
+"tests/*.py" = ["E501"]
+
+[tool.ruff.mccabe]
+max-complexity = 3

tests/test_command.py

@@ -16,7 +16,7 @@ def test_command_escape_message(capsys):
     captured = capsys.readouterr()
     assert (
         captured.out
-        == f'::some-command::percent %25 percent %25 cr %0D cr %0D lf %0A lf %0A{os.linesep}'  # noqa: E501
+        == f'::some-command::percent %25 percent %25 cr %0D cr %0D lf %0A lf %0A{os.linesep}'
     )
 
     # verify literal escape sequences
@@ -32,14 +32,14 @@ def test_command_escape_property(capsys):
     issue_command(
         'some-command',
         {
-            'name': 'percent % percent % cr \r cr \r lf \n lf \n colon : colon : comma , comma ,'  # noqa: E501
+            'name': 'percent % percent % cr \r cr \r lf \n lf \n colon : colon : comma , comma ,'
         },
         '',
     )
     captured = capsys.readouterr()
     assert (
         captured.out
-        == f'::some-command name=percent %25 percent %25 cr %0D cr %0D lf %0A lf %0A colon %3A colon %3A comma %2C comma %2C::{os.linesep}'  # noqa: E501
+        == f'::some-command name=percent %25 percent %25 cr %0D cr %0D lf %0A lf %0A colon %3A colon %3A comma %2C comma %2C::{os.linesep}'
     )
 
     # Verify literal escape sequences
@@ -51,7 +51,7 @@ def test_command_escape_property(capsys):
     captured = capsys.readouterr()
     assert (
         captured.out
-        == f'::some-command::%2525 %2525 %250D %250D %250A %250A %253A %253A %252C %252C{os.linesep}'  # noqa: E501
+        == f'::some-command::%2525 %2525 %250D %250D %250A %250A %253A %253A %252C %252C{os.linesep}'
     )
 
 
@@ -70,7 +70,7 @@ def test_command_with_message_properties(capsys):
     captured = capsys.readouterr()
     assert (
         captured.out
-        == f'::some-command prop1=value 1,prop2=value 2::some message{os.linesep}'  # noqa: E501
+        == f'::some-command prop1=value 1,prop2=value 2::some message{os.linesep}'
     )
 
 
@@ -102,7 +102,7 @@ def test_command_with_three_properties(capsys):
     captured = capsys.readouterr()
     assert (
         captured.out
-        == f'::some-command prop1=value 1,prop2=value 2,prop3=value 3::{os.linesep}'  # noqa: E501
+        == f'::some-command prop1=value 1,prop2=value 2,prop3=value 3::{os.linesep}'
     )
 
 
@@ -118,5 +118,5 @@ def test_command_with_non_string_props(capsys):
     )
 
     captured = capsys.readouterr()
-    part_out = '::some-command prop1={"test"%3A "object"},prop2=123,prop3=true::{"test": "object"}'  # noqa: E501
+    part_out = '::some-command prop1={"test"%3A "object"},prop2=123,prop3=true::{"test": "object"}'
     assert captured.out == f'{part_out}{os.linesep}'

tests/test_core.py

@@ -26,7 +26,7 @@ def test_is_debug():
 
 def test_set_failed_sets_correct_exit_code_failure_message(capsys):
     failure_message = 'Failure message'
-    with pytest.raises(SystemExit) as e:   # noqa
+    with pytest.raises(SystemExit) as e:
         set_failed(failure_message)
 
     captured = capsys.readouterr()