Merge pull request #5 from greglucas/pre-commit-hooks

MNT: Adding more pre-commit hooks

.github/workflows/test.yml

@@ -30,7 +30,7 @@ jobs:
       - name: Install dependencies and app
         run: |
           poetry install --extras "test"
-      
+
       - name: Testing
         id: test
         run: |

.pre-commit-config.yaml

@@ -1,8 +1,17 @@
 ci:
   autofix_prs: false
   autoupdate_schedule: 'quarterly'
-  skip: [poetry-lock, poetry-export]
+  skip: [poetry-lock]
 repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    - id: check-added-large-files
+    - id: detect-aws-credentials
+      args: [--allow-missing-credentials]
+    - id: detect-private-key
+    - id: mixed-line-ending
+    - id: trailing-whitespace
   - repo: https://github.com/psf/black
     rev: 22.12.0
     hooks:

imap_processing/packet_definitions/swe_packet_definition.xml

@@ -15,7 +15,7 @@
             In this case, the uint1 data type is an unsigned integer with a size of 1 bit.
 
             For fields that have meanings based on the values they evaluate to, enumerated data types need to be created.
-            
+
             Here's an example:
                 <xtce:EnumeratedParameterType name="cem_nominal_enum" signed="false">
                     <xtce:UnitSet/>
@@ -26,7 +26,7 @@
                     </xtce:EnumerationList>
                 </xtce:EnumeratedParameterType>
 
-            In this case, the cem_nominal_enum data type is an enumerated type with a size of 1 bit. It has two possible values: 
+            In this case, the cem_nominal_enum data type is an enumerated type with a size of 1 bit. It has two possible values:
                 "NOT_NOMINAL" with a value of 0 and "NOMINAL" with a value of 1.
 
             By defining the appropriate data types within the ParameterTypeSet, you ensure that the data fields in the packet definitions
@@ -148,7 +148,7 @@
             </xtce:Parameter>
             <xtce:Parameter name="CEM_NOMINAL_ONLY" parameterTypeRef="cem_nominal_enum">
                 <xtce:LongDescription>
-                    CEM Nominal status bit: 
+                    CEM Nominal status bit:
                     '1' -- nominal,
                     '0' -- not nomimal
                 </xtce:LongDescription>

imap_processing/swe/decom_swe.py

@@ -1,4 +1,3 @@
-
 from imap_processing import decom
 
 

imap_processing/swe/tests/test_decom.py

@@ -1,4 +1,3 @@
-
 import pytest
 
 from imap_processing.swe import decom_swe
@@ -22,7 +21,8 @@ def test_ccsds_header(decom_test_data):
     """Test if packet header contains default CCSDS header
 
     These are the field required in CCSDS header:
-        'VERSION', 'TYPE', 'SEC_HDR_FLG', 'PKT_APID', 'SEG_FLGS', 'SRC_SEQ_CTR', 'PKT_LEN'
+        'VERSION', 'TYPE', 'SEC_HDR_FLG', 'PKT_APID',
+        'SEG_FLGS', 'SRC_SEQ_CTR', 'PKT_LEN'
     """
     # Required CCSDS header fields
     ccsds_header_keys = [
@@ -36,8 +36,8 @@ def test_ccsds_header(decom_test_data):
     ]
 
     # decom_test_data[0].header is one way to get the header data. Another way to get it
-    # is using list method. Eg. ccsds_header = decom_test_data[0][0]. Each packet's 0th index
-    # has header data and index 1 has data.
+    # is using list method. Eg. ccsds_header = decom_test_data[0][0].
+    # Each packet's 0th index has header data and index 1 has data.
 
     # First way to get header data
     ccsds_header = decom_test_data[0].header

pyproject.toml

@@ -58,4 +58,4 @@ target-version = "py39"
 select = ["B", "E", "F", "I", "N", "S", "W", "PL", "PT", "UP", "RUF"]
 # Ignore import sorting for now until lines_after_imports is respected
 # by ruff and we can replace isort
-ignore = ["D203", "D212", "PLR0913", "PLR2004"]
+ignore = ["D203", "D212", "PLR0913", "PLR2004", "S101"]