Ruff format

Author: nyalldawson

bintools/extract_bin.py

@@ -9,57 +9,64 @@
 import argparse
 
 parser = argparse.ArgumentParser()
-parser.add_argument("file", help="style file to extract",nargs='?')
+parser.add_argument("file", help="style file to extract", nargs="?")
 args = parser.parse_args()
 print(args.file)
 
 try:
-    driver = [d for d in pyodbc.drivers() if 'Microsoft Access' in d][0]
+    driver = [d for d in pyodbc.drivers() if "Microsoft Access" in d][0]
 except AttributeError:
     driver = None
 
 
 def clean_symbol_name_for_file(symbol_name):
     """nasty little function to remove some characters which will choke"""
     file_name = symbol_name
-    file_name = file_name.replace('/', '_')
-    file_name = file_name.replace('>', '_')
-    file_name = file_name.replace('\\', '_')
-    file_name = file_name.replace('?', '_')
-    file_name = file_name.replace('*', '_')
+    file_name = file_name.replace("/", "_")
+    file_name = file_name.replace(">", "_")
+    file_name = file_name.replace("\\", "_")
+    file_name = file_name.replace("?", "_")
+    file_name = file_name.replace("*", "_")
     return file_name
 
+
 if not args.file:
-    styles=[('fill','fill'),('line','line'),('marker','marker'),('fill105','fill')]
-    styles=[(os.path.join('styles',s[0] + '.style'),s[1]) for s in styles]
-    output_path = os.path.join('styles', 'bin')
+    styles = [
+        ("fill", "fill"),
+        ("line", "line"),
+        ("marker", "marker"),
+        ("fill105", "fill"),
+    ]
+    styles = [(os.path.join("styles", s[0] + ".style"), s[1]) for s in styles]
+    output_path = os.path.join("styles", "bin")
 else:
-    styles=[(args.file, 'fill'),(args.file, 'line'),(args.file, 'marker')]
+    styles = [(args.file, "fill"), (args.file, "line"), (args.file, "marker")]
     output_path, _ = os.path.split(args.file)
 
-for (fill_style_db,type) in styles:
+for fill_style_db, type in styles:
     if driver is not None:
         # windows
-        con = pyodbc.connect('DRIVER={};DBQ={}'.format(driver,fill_style_db))
+        con = pyodbc.connect("DRIVER={};DBQ={}".format(driver, fill_style_db))
     else:
         # linux
-        con = pyodbc.connect('DRIVER=/usr/lib64/libmdbodbc.so;DBQ={}'.format(fill_style_db))
+        con = pyodbc.connect(
+            "DRIVER=/usr/lib64/libmdbodbc.so;DBQ={}".format(fill_style_db)
+        )
 
     # grab fill symbols
     cur = con.cursor()
-    SQL = 'SELECT name, object FROM [{} Symbols];'.format(type)
+    SQL = "SELECT name, object FROM [{} Symbols];".format(type)
     rows = cur.execute(SQL).fetchall()
     cur.close()
     con.close()
 
     for r in rows:
-        symbol_name=r[0]
-        blob=r[1]
+        symbol_name = r[0]
+        blob = r[1]
 
-        out_filename=clean_symbol_name_for_file(symbol_name) + '.bin'
-        file = os.path.join(output_path,out_filename)
+        out_filename = clean_symbol_name_for_file(symbol_name) + ".bin"
+        file = os.path.join(output_path, out_filename)
 
         print(file)
-        with open(file, 'wb') as e:
+        with open(file, "wb") as e:
             e.write(blob)
-

pyproject.toml

@@ -0,0 +1,2 @@
+[tool.ruff]
+exclude = ["slyr_community/parser/cim", "slyr_community/parser/color_lut.py"]

slyr_community/__init__.py

@@ -26,5 +26,6 @@
 
 def classFactory(iface):
     """invoke plugin"""
-    from slyr_community.plugin import SlyrPlugin    # pylint: disable=import-outside-toplevel
+    from slyr_community.plugin import SlyrPlugin  # pylint: disable=import-outside-toplevel
+
     return SlyrPlugin(iface)

slyr_community/bintools/extractor.py

@@ -47,42 +47,44 @@ class Extractor:
     # binary blobs too. So we overwrite all the default newline, delimiter,
     # and quotation characters with strings which are almost guaranteed
     # to never come up in an ESRI style blob ;)
-    __NEWLINE = b'arcgissuxxxxxxxxxx'
-    __DELIMITER = b'reallynooneneedstopayourexorbitantlicensingfeesjustembracethefossinstead'
-    __QUOTE = b'qgisisthebestweallknowthat'
-
-    COLORS = 'Colors'
-    FILL_SYMBOLS = 'Fill symbols'
-    LINE_SYMBOLS = 'Line symbols'
-    MARKER_SYMBOLS = 'Marker symbols'
-    COLOR_RAMPS = 'Color ramps'
-    LABELS = 'Labels'
-    MAPLEX_LABELS = 'Maplex Labels'
-    AREA_PATCHES = 'Area Patches'
-    LINE_PATCHES = 'Line Patches'
-    SCALE_BARS = 'Scale Bars'
-    LEGEND_ITEMS = 'Legend Items'
-    SCALE_TEXTS = 'Scale Texts'
-    BORDERS = 'Borders'
-    BACKGROUNDS = 'Backgrounds'
-    TEXT_SYMBOLS = 'Text Symbols'
-    NORTH_ARROWS = 'North Arrows'
-    SHADOWS = 'Shadows'
-
-    NAME = 'NAME'
-    TAGS = 'TAGS'
-    CATEGORY = 'CATEGORY'
-    ID = 'ID'
-    BLOB = 'BLOB'
-
-    MDB_EXPORT_BINARY = 'mdb-export'
+    __NEWLINE = b"arcgissuxxxxxxxxxx"
+    __DELIMITER = (
+        b"reallynooneneedstopayourexorbitantlicensingfeesjustembracethefossinstead"
+    )
+    __QUOTE = b"qgisisthebestweallknowthat"
+
+    COLORS = "Colors"
+    FILL_SYMBOLS = "Fill symbols"
+    LINE_SYMBOLS = "Line symbols"
+    MARKER_SYMBOLS = "Marker symbols"
+    COLOR_RAMPS = "Color ramps"
+    LABELS = "Labels"
+    MAPLEX_LABELS = "Maplex Labels"
+    AREA_PATCHES = "Area Patches"
+    LINE_PATCHES = "Line Patches"
+    SCALE_BARS = "Scale Bars"
+    LEGEND_ITEMS = "Legend Items"
+    SCALE_TEXTS = "Scale Texts"
+    BORDERS = "Borders"
+    BACKGROUNDS = "Backgrounds"
+    TEXT_SYMBOLS = "Text Symbols"
+    NORTH_ARROWS = "North Arrows"
+    SHADOWS = "Shadows"
+
+    NAME = "NAME"
+    TAGS = "TAGS"
+    CATEGORY = "CATEGORY"
+    ID = "ID"
+    BLOB = "BLOB"
+
+    MDB_EXPORT_BINARY = "mdb-export"
 
     @staticmethod
     def is_windows() -> bool:
         """
         Returns True if the plugin is running on Windows
         """
-        return os.name == 'nt'
+        return os.name == "nt"
 
     @staticmethod
     def get_process_startup_info():
@@ -112,9 +114,9 @@ def get_process_keywords():
         """
         kw = {}
         if Extractor.is_windows():
-            kw['startupinfo'] = Extractor.get_process_startup_info()
+            kw["startupinfo"] = Extractor.get_process_startup_info()
             if sys.version_info >= (3, 6):
-                kw['encoding'] = "cp{}".format(Extractor.get_windows_code_page())
+                kw["encoding"] = "cp{}".format(Extractor.get_windows_code_page())
         return kw
 
     @staticmethod
@@ -124,11 +126,11 @@ def get_mdb_tools_binary_path(executable: str) -> str:
         :param executable: mdb tools executable name
         :return: path for executable
         """
-        mdbtools_path = QSettings().value('/plugins/slyr/mdbtools_path')
+        mdbtools_path = QSettings().value("/plugins/slyr/mdbtools_path")
         if mdbtools_path:
             return os.path.join(mdbtools_path, executable)
         elif Extractor.is_windows():
-            return os.path.join(os.path.dirname(__file__), 'bin', executable)
+            return os.path.join(os.path.dirname(__file__), "bin", executable)
         return executable
 
     @staticmethod
@@ -140,14 +142,16 @@ def is_mdb_tools_binary_available() -> bool:
 
         command = [Extractor.get_mdb_tools_binary_path(Extractor.MDB_EXPORT_BINARY)]
         try:
-            with subprocess.Popen(command,
-                                  stdout=subprocess.PIPE,
-                                  stdin=subprocess.DEVNULL,
-                                  stderr=subprocess.STDOUT,
-                                  universal_newlines=True,
-                                  **Extractor.get_process_keywords()) as proc:
+            with subprocess.Popen(
+                command,
+                stdout=subprocess.PIPE,
+                stdin=subprocess.DEVNULL,
+                stderr=subprocess.STDOUT,
+                universal_newlines=True,
+                **Extractor.get_process_keywords(),
+            ) as proc:
                 for line in proc.stdout:
-                    if 'row-delimiter' in line:
+                    if "row-delimiter" in line:
                         return True
         except FileNotFoundError:
             pass
@@ -159,10 +163,10 @@ def _remove_quote(val):
         """
         Removes the custom quotation character from start/end of values
         """
-        if val[:len(Extractor.__QUOTE)] == Extractor.__QUOTE:
-            val = val[len(Extractor.__QUOTE):]
-        if val[-len(Extractor.__QUOTE):] == Extractor.__QUOTE:
-            val = val[:-len(Extractor.__QUOTE)]
+        if val[: len(Extractor.__QUOTE)] == Extractor.__QUOTE:
+            val = val[len(Extractor.__QUOTE) :]
+        if val[-len(Extractor.__QUOTE) :] == Extractor.__QUOTE:
+            val = val[: -len(Extractor.__QUOTE)]
         return val
 
     @staticmethod
@@ -174,9 +178,9 @@ def _extract_text(val):
         """
         val = Extractor._remove_quote(val)
         try:
-            val = val.decode('UTF-8')
+            val = val.decode("UTF-8")
         except UnicodeDecodeError:
-            val = val.decode('latin-1')
+            val = val.decode("latin-1")
         return val
 
     @staticmethod
@@ -185,7 +189,7 @@ def _format_value(val):
         Tries to convert a string value to a nicer type
         """
         val = Extractor._extract_text(val)
-        if val == '':
+        if val == "":
             return None
 
         try:
@@ -206,7 +210,11 @@ def extract_non_spatial_table_from_mdb(file_path: str, table_name: str):
         :param table_name: table name to extract
         :return: list of row values (first line is header)
         """
-        raise RequiresLicenseException('Converting {} document requires a licensed version of SLYR'.format(file_path))
+        raise RequiresLicenseException(
+            "Converting {} document requires a licensed version of SLYR".format(
+                file_path
+            )
+        )
 
     @staticmethod
     def extract_styles(file_path: str, symbol_type: str):  # pylint: disable=too-many-locals,too-many-branches,too-many-statements
@@ -218,22 +226,27 @@ def extract_styles(file_path: str, symbol_type: str):  # pylint: disable=too-man
         """
         binary = Extractor.get_mdb_tools_binary_path(Extractor.MDB_EXPORT_BINARY)
 
-        export_args = [binary,
-                       '-q',
-                       '{}'.format(Extractor.__QUOTE.decode('ASCII')),
-                       '-R',
-                       '{}'.format(Extractor.__NEWLINE.decode('ASCII')),
-                       '-d',
-                       '{}'.format(Extractor.__DELIMITER.decode('ASCII')),
-                       '-b',
-                       'raw',
-                       file_path,
-                       symbol_type]
+        export_args = [
+            binary,
+            "-q",
+            "{}".format(Extractor.__QUOTE.decode("ASCII")),
+            "-R",
+            "{}".format(Extractor.__NEWLINE.decode("ASCII")),
+            "-d",
+            "{}".format(Extractor.__DELIMITER.decode("ASCII")),
+            "-b",
+            "raw",
+            file_path,
+            symbol_type,
+        ]
 
         CREATE_NO_WINDOW = 0x08000000
         try:
-            result = subprocess.run(export_args, stdout=subprocess.PIPE,  # pylint: disable=subprocess-run-check
-                                    creationflags=CREATE_NO_WINDOW)
+            result = subprocess.run(
+                export_args,
+                stdout=subprocess.PIPE,  # pylint: disable=subprocess-run-check
+                creationflags=CREATE_NO_WINDOW,
+            )
         except ValueError:
             try:
                 result = subprocess.run(export_args, stdout=subprocess.PIPE)  # pylint: disable=subprocess-run-check
@@ -256,16 +269,16 @@ def extract_styles(file_path: str, symbol_type: str):  # pylint: disable=too-man
             if headers is None:
                 headers = r.split(Extractor.__DELIMITER)
                 for idx, header in enumerate(headers):
-                    header = header.decode('utf-8')
-                    if header.lower().strip() == 'name':
+                    header = header.decode("utf-8")
+                    if header.lower().strip() == "name":
                         name_idx = idx
-                    elif header.lower().strip() == 'category':
+                    elif header.lower().strip() == "category":
                         category_idx = idx
-                    elif header.lower().strip() == 'object':
+                    elif header.lower().strip() == "object":
                         blob_idx = idx
-                    elif header.lower().strip() == 'tags':
+                    elif header.lower().strip() == "tags":
                         tags_idx = idx
-                    elif header.lower().strip() == 'id':
+                    elif header.lower().strip() == "id":
                         symbol_id_idx = idx
                 continue
 
@@ -288,14 +301,14 @@ def extract_styles(file_path: str, symbol_type: str):  # pylint: disable=too-man
             if Extractor.is_windows():
                 # on windows, mdbtools does a weird thing and replaces all 0a bytes with 0a0d. Wonderful wonderful
                 # Windows new endings come round to bite us again
-                blob = blob.replace(b'\r\n', b'\n')
+                blob = blob.replace(b"\r\n", b"\n")
 
             symbol = {
                 Extractor.NAME: Extractor._extract_text(name),
                 Extractor.CATEGORY: Extractor._extract_text(category),
-                Extractor.TAGS: Extractor._extract_text(tags) if tags else '',
+                Extractor.TAGS: Extractor._extract_text(tags) if tags else "",
                 Extractor.ID: Extractor._extract_text(symbol_id),
-                Extractor.BLOB: blob
+                Extractor.BLOB: blob,
             }
             raw_symbols.append(symbol)
 

slyr_community/bintools/file_utils.py

@@ -33,12 +33,12 @@ class FileUtils:
     def clean_symbol_name_for_file(symbol_name):
         """nasty little function to remove some characters which will choke"""
         file_name = symbol_name
-        file_name = file_name.replace('/', '_')
-        file_name = file_name.replace('>', '_')
-        file_name = file_name.replace('<', '_')
-        file_name = file_name.replace('\\', '_')
-        file_name = file_name.replace('?', '_')
-        file_name = file_name.replace('*', '_')
-        file_name = file_name.replace('"', '_')
-        file_name = file_name.replace(':', '_')
+        file_name = file_name.replace("/", "_")
+        file_name = file_name.replace(">", "_")
+        file_name = file_name.replace("<", "_")
+        file_name = file_name.replace("\\", "_")
+        file_name = file_name.replace("?", "_")
+        file_name = file_name.replace("*", "_")
+        file_name = file_name.replace('"', "_")
+        file_name = file_name.replace(":", "_")
         return file_name.strip()