ADD-WIP: basic structure for pre-commits local + mypy setup

Author: 9and3

deps/cgal/auxiliary/gdb/python/CGAL/printers.py

@@ -23,7 +23,7 @@ def lookup_function (val):
     # Get the unqualified type, stripped of typedefs.
     type = type.unqualified ().strip_typedefs ()
 
-    # Get the type name.    
+    # Get the type name.
     typename = type.tag
     if typename == None:
         return None
@@ -34,7 +34,7 @@ def lookup_function (val):
     for function in CGAL_pretty_printers_dict:
         if function.search (typename):
             return CGAL_pretty_printers_dict[function] (val)
-        
+
     # Cannot find a pretty printer.  Return None.
     return None
 
@@ -43,15 +43,15 @@ def lookup_function (val):
 class CGAL_Handle_for:
     def __init__(self, val):
         self.val = val
-        
+
     def to_string (self):
         node = self.val['ptr_'].dereference()
         return 'Handle_for(%s , refcount=%d)' % (node['t'],node['count'])
 
 class CGAL_Point_2:
     def __init__(self, val):
         self.val = val
-        
+
     def to_string (self):
         node = self.val;
         type = self.val.type
@@ -64,15 +64,15 @@ def to_string (self):
 class CGAL_Tdsvb3:
     def __init__(self, val):
         self.val = val
-        
+
     def to_string (self):
         node = self.val;
         return 'CGAL::Tvb_3(%s)' % node['_p']
 
 class CGAL_Point_3:
     def __init__(self, val):
         self.val = val
-        
+
     def to_string (self):
         node = self.val;
         type = self.val.type
@@ -86,23 +86,23 @@ class CGAL_Vector_2:
     def __init__(self, val, name):
         self.val = val
         self.name = name
-        
+
     def to_string (self):
         node = self.val['base']
         return 'CGAL::%s(%s)' % (self.name, node)
 
 class CGAL_Array:
     def __init__(self, val):
         self.val = val
-        
+
     def to_string (self):
         node = self.val['_M_instance']
         return node
 
 class CGAL_Boost_tuples:
     def __init__(self, val):
         self.val = val
-        
+
     def to_string (self):
         return '{%s}' % self.display_head_and_continue(self.val)
 
@@ -135,4 +135,3 @@ def display_head_and_continue(self, val):
 
 CGAL_pretty_printers_dict[re.compile('^(std|boost)(::tr1)?(::tuples)?::tuple<.*>')] = lambda val: CGAL_Boost_tuples(val)
 #p2 = gdb.selected_frame().read_var('p2')
-

doc/conf.py

@@ -188,7 +188,7 @@
     'navigation_with_keys': False,
 }
 
-# Add any paths that contain custom 
+# Add any paths that contain custom
 # static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
@@ -339,4 +339,4 @@ def linkcode_resolve(domain, info):
     return None
   filename = os.path.relpath(filename, start=os.path.dirname(diffCheck.__file__))
   lines = f"#L{linenum}-L{linenum + len(source)}" if linenum else ""
-  return f"https://github.com/diffCheckOrg/diffCheck/blob/main/diffCheck/{filename}{lines}"
+  return f"https://github.com/diffCheckOrg/diffCheck/blob/main/diffCheck/{filename}{lines}"

doc/contribute.md

@@ -1,13 +1,17 @@
 (contrib_guide)=
 # Contribute
 
-We value all contributions to diffCheck, whether they are bug reports, feature requests, or pull requests. We have a few guidelines to ensure that the process is as smooth as possible.
+We welcome pull requests from everyone. Please have a look at the [issue](https://github.com/diffCheckOrg/diffCheck/issues) list to see if there is something you can help with. If you have a new feature in mind, please open an issue to discuss it first.
 
-## How to contribute
+## Code quality
 
-We welcome pull requests from everyone. Please have a look at the [issue](https://github.com/diffCheckOrg/diffCheck/issues) list to see if there is something you can help with. If you have a new feature in mind, please open an issue to discuss it first.
+We run [mypy](https://mypy.readthedocs.io/en/stable/index.html) and [] on pre-commit hooks to ensure code quality. Please make sure to run the following commands before submitting a pull request:
 
-To contribute, you will need to install your developer's environment to build the project. You can find the instructions in the [development installation guide](dev_documentation).
+```console
+pre-commit run --all-files
+```
+
+## How to contribute
 
 Next, fall the following steps:
 
@@ -24,4 +28,10 @@ Next, fall the following steps:
 
     ```console
     git checkout -b my-feature
-    ``` 
+    ```
+
+4. Add the diffCheck repository as a remote for convinience:
+
+    ```console
+    git remote add upstream https://github.com/diffCheckOrg/diffCheck
+    ```

doc/sphinx_ghcomponent_parser/__init__.py

@@ -24,7 +24,7 @@ def run(self):
         metadata_json_file = os.path.join(ghcomponent_dir, 'metadata.json')
         pycode_file = os.path.join(ghcomponent_dir, 'code.py')
         icon_file = os.path.join(ghcomponent_dir, 'icon.png')
-        
+
         metadata = metadata_parser.MetadataParser(metadata_json_file)
 
         ##########################################################################
@@ -47,7 +47,7 @@ def run(self):
         table += tgroup
         tgroup += nodes.colspec(colwidth=1)
         tgroup += nodes.colspec(colwidth=1)
-        
+
         tbody = nodes.tbody()
         tgroup += tbody
         if metadata.get_input_parameters():
@@ -71,7 +71,7 @@ def run(self):
         table += tgroup
         tgroup += nodes.colspec(colwidth=1)
         tgroup += nodes.colspec(colwidth=1)
-        
+
         tbody = nodes.tbody()
         tgroup += tbody
         if metadata.get_output_parameters():
@@ -103,4 +103,4 @@ def setup(app):
         'version': '0.1',
         'parallel_read_safe': True,
         'parallel_write_safe': True,
-    }
+    }

doc/sphinx_ghcomponent_parser/metadata_parser.py

@@ -61,7 +61,7 @@ def return_rst_content(self):
         # for key, value in self.get_ghpython_settings().items():
         #     content.append(f"{'#' * 3} {key}: {value}")
 
-        
+
 
         params = self.get_input_parameters()
         # if params:  # Ensure params is not empty
@@ -104,4 +104,4 @@ def return_rst_content(self):
             # content.append(f"{'#' * 3} Wire Display: {param.get('wireDisplay', '')}")
             # content.append(f"{'#' * 3} Source Count: {param.get('sourceCount', 0)}")
             # content.append(f"{'#' * 3} Type Hint ID: {param.get('typeHintID', '')}")
-        # return content
+        # return content

doc/test_pybind_dll_smoke.py

@@ -26,4 +26,4 @@
 
 # if __name__ == "__main__":
 #     pytest.main()
-print(">>>>>>>>>>>>>>>>> test_pybind_dll_smoke.py succeded <<<<<<<<<<<<<<<<<<<<")
+print(">>>>>>>>>>>>>>>>> test_pybind_dll_smoke.py succeded <<<<<<<<<<<<<<<<<<<<")

environment.yml

@@ -148,4 +148,4 @@ def main(
         print("[x] Done flagerizing components.")
     else:
         print("[ ] Failed flagerizing components.")
-        sys.exit(1)
+        sys.exit(1)

invokes/flagerize.py

@@ -382,7 +382,7 @@ def create_ghuser_component(source, target, version=None, prefix=None):
         sys.exit(-1)
 
     clr.AddReference(os.path.splitext(gh_io)[0])
-    
+
     print("[x] GH_IO assembly: {}".format(gh_io))
 
     print("Processing component bundles:")
@@ -391,4 +391,4 @@ def create_ghuser_component(source, target, version=None, prefix=None):
         target = os.path.join(targetdir, d + ".ghuser")
         print("  [ ] {}\r".format(d), end="")
         create_ghuser_component(source, target, args.version, args.prefix)
-        print("  [x] {} => {}".format(d, target))
+        print("  [x] {} => {}".format(d, target))

invokes/ghcomponentize/ghcomponentizer.py

@@ -58,4 +58,4 @@ def main(
         print("[x] Pypireize task completed.")
     else:
         print("[ ] Pypireize task failed.")
-        sys.exit(1)
+        sys.exit(1)