mkdocstrings-matlab 0.9.1__py3-none-any.whl → 0.9.3__py3-none-any.whl

mkdocstrings_handlers/matlab/handler.py

@@ -358,7 +358,15 @@ class MatlabHandler(BaseHandler):
             raise CollectionError("Empty identifier")
 
         final_config = ChainMap(config, self.default_config)  # type: ignore[arg-type]
-        model = self.paths.resolve(identifier, config=final_config)
+        try:
+            model = self.paths.resolve(identifier, config=final_config)
+        except SyntaxError as ex:
+            msg = str(ex)
+            if ex.text:
+                msg += ':\n' + ex.text
+            raise CollectionError(msg) from ex
+        except Exception as ex:
+            raise CollectionError(str(ex)) from ex
         if model is None:
             raise CollectionError(f"Identifier '{identifier}' not found")
         return model

mkdocstrings_handlers/matlab/treesitter.py

@@ -198,6 +198,7 @@ class FileParser(object):
         self.encoding: str = result.encoding if result else "utf-8"
         with open(filepath, "rb") as f:
             self._content: bytes = f.read()
+        self._node: Node | None = None
 
     @property
     def content(self):
@@ -226,26 +227,38 @@ class FileParser(object):
         Raises:
             ValueError: If the file could not be parsed.
         """
-        tree = PARSER.parse(self._content)
-        cursor = tree.walk()
-
-        if cursor.node is None:
-            raise ValueError(f"The file {self.filepath} could not be parsed.")
-        captures = FILE_QUERY.captures(cursor.node)
-
-        if "function" in captures:
-            model = self._parse_function(captures["function"][0], **kwargs)
-        elif "class" in captures:
-            model = self._parse_class(captures["class"][0], **kwargs)
-        else:
-            model = Script(self.filepath.stem, filepath=self.filepath, **kwargs)
+        try:
+            tree = PARSER.parse(self._content)
+            cursor = tree.walk()
+
+            if cursor.node is None:
+                raise ValueError(f"The file {self.filepath} could not be parsed.")
+            captures = FILE_QUERY.captures(cursor.node)
+            if "function" in captures:
+                model = self._parse_function(captures["function"][0], **kwargs)
+            elif "class" in captures:
+                model = self._parse_class(captures["class"][0], **kwargs)
+            else:
+                model = Script(self.filepath.stem, filepath=self.filepath, **kwargs)
 
-        if not model.docstring:
-            model.docstring = self._comment_docstring(
-                captures.get("header", None), parent=model
-            )
+            if not model.docstring:
+                model.docstring = self._comment_docstring(
+                    captures.get("header", None), parent=model
+                )
 
-        return model
+            return model
+        except Exception as ex:
+            syntax_error = SyntaxError(f"Error parsing Matlab file")
+            syntax_error.filename = str(self.filepath)
+            if self._node is not None:
+                if self._node.text is not None:
+                    indentation = ' ' * self._node.start_point.column
+                    syntax_error.text = indentation + self._node.text.decode(self.encoding)
+                syntax_error.lineno = self._node.start_point.row + 1
+                syntax_error.offset = self._node.start_point.column + 1
+                syntax_error.end_lineno = self._node.end_point.row + 1
+                syntax_error.end_offset = self._node.end_point.column + 1
+            raise syntax_error from ex
 
     def _parse_class(self, node: Node, **kwargs: Any) -> Class:
         """
@@ -262,6 +275,7 @@ class FileParser(object):
         Returns:
             Class: The parsed Class or Classfolder model.
         """
+        self._node = node
         saved_kwargs = {key: value for key, value in kwargs.items()}
         captures = CLASS_QUERY.captures(node)
 
@@ -401,6 +415,7 @@ class FileParser(object):
                              The value is `True` if no value is specified,
                              otherwise it is the parsed value which can be a boolean or a string.
         """
+        self._node = node
         captures = ATTRIBUTE_QUERY.captures(node)
 
         key = self._first_from_capture(captures, "name")
@@ -429,6 +444,7 @@ class FileParser(object):
             KeyError: If required captures are missing from the node.
 
         """
+        self._node = node
         captures: dict = FUNCTION_QUERY.matches(node)[0][1]
 
         input_names = self._decode_from_capture(captures, "input")
@@ -529,6 +545,7 @@ class FileParser(object):
         Returns:
             str: The decoded text of the node. If the node or its text is None, returns an empty string.
         """
+        self._node = node
         return (
             node.text.decode(self.encoding)
             if node is not None and node.text is not None
@@ -621,6 +638,18 @@ class FileParser(object):
             except StopIteration:
                 break
 
+            # Exclude all pragma's
+            if line in [
+                '%#codegen',
+                '%#eml',
+                '%#external',
+                '%#exclude',
+                '%#function',
+                '%#ok',
+                '%#mex',
+            ]:
+                continue
+
             if "--8<--" in line:
                 continue
 

{mkdocstrings_matlab-0.9.1.dist-info → mkdocstrings_matlab-0.9.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-matlab
-Version: 0.9.1
+Version: 0.9.3
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -25,7 +25,7 @@ Requires-Dist: charset-normalizer==3.4.1
 Requires-Dist: mkdocstrings-python==1.13.0
 Requires-Dist: mkdocstrings==0.27.0
 Requires-Dist: tree-sitter-matlab==1.0.3
-Requires-Dist: tree-sitter==0.23.2
+Requires-Dist: tree-sitter==0.24.0
 Description-Content-Type: text/markdown
 
 <!-- --8<-- [start:header] -->

{mkdocstrings_matlab-0.9.1.dist-info → mkdocstrings_matlab-0.9.3.dist-info}/RECORD

@@ -1,10 +1,10 @@
 mkdocstrings_handlers/matlab/__init__.py,sha256=w5R9cGtqeJF0GUP_Jc_ad8FnS4FpbutnmHvzVRlohPM,1124
 mkdocstrings_handlers/matlab/collect.py,sha256=6GkAwKor11Hm9QvKr6cKSHuylpoMF4Y3c8_myKiYOdE,29677
 mkdocstrings_handlers/matlab/enums.py,sha256=Lzc8MLar-uMoKplT5LxF1lXNBfjHc9MCTe2b0mJMc10,1540
-mkdocstrings_handlers/matlab/handler.py,sha256=5EK559dDElhNI9owKmia72Nl02MBULUaa1Dd-zCCeSE,19718
+mkdocstrings_handlers/matlab/handler.py,sha256=TK3a19O-m668qtnf7r1bRRI9TVWm3vZf1LnOj1e8uQw,19988
 mkdocstrings_handlers/matlab/models.py,sha256=2kMF7dyg5nPAzJt9G48IVtNAAq8K6xyKCBDDZHOBtUQ,19614
 mkdocstrings_handlers/matlab/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mkdocstrings_handlers/matlab/treesitter.py,sha256=mpYNAoIU_nxvyisYLYzXllKjWKUKu0pkk8_e3RqVNaE,22284
+mkdocstrings_handlers/matlab/treesitter.py,sha256=lnpnwNOb22FvS7mykG3qs5rd5aPwvRJplHqOqC1vDbE,23526
 mkdocstrings_handlers/matlab/templates/material/children.html.jinja,sha256=xF_J8afiIciWTP1GBhGAGWXe36wl0zJBKCwa2uDQFbU,7409
 mkdocstrings_handlers/matlab/templates/material/folder.html.jinja,sha256=cWgaQH4EDFgL3eEIv0NRwRXYvtn9pp4tW7ntv3X2nM8,4076
 mkdocstrings_handlers/matlab/templates/material/namespace.html.jinja,sha256=a7Ya3YuN3hNEvqb_aG5Yr3QCuFYv6UhX5B26Gx2-tUQ,4099
@@ -16,7 +16,7 @@ mkdocstrings_handlers/matlab/templates/material/docstring/namespaces.html.jinja,
 mkdocstrings_handlers/matlab/templates/material/docstring/properties.html.jinja,sha256=9ckdYymLlB5sflwYEaEPAQLJuVWF8nezMCV5JnanXVA,4165
 mkdocstrings_handlers/matlab/templates/material/summary/namespaces.html.jinja,sha256=0vVlUB6oh-A7cpXbuDLOQLxTubyb_DisdOKm062WNMs,650
 mkdocstrings_handlers/matlab/templates/material/summary/properties.html.jinja,sha256=nyPaELf9qPCxJQFxK1MWYK4fPwsk5VESh9xKHLtd-XE,643
-mkdocstrings_matlab-0.9.1.dist-info/METADATA,sha256=nGcZZuakb88AhvWVFsfaDaZcr5pJJ7vYVGJUTa2a_Xw,4736
-mkdocstrings_matlab-0.9.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-mkdocstrings_matlab-0.9.1.dist-info/licenses/LICENSE,sha256=TZQpwBuA3KLH56--XDAY2Qwo9gGdxeTITYhMOylmYhg,743
-mkdocstrings_matlab-0.9.1.dist-info/RECORD,,
+mkdocstrings_matlab-0.9.3.dist-info/METADATA,sha256=KfUWqpFqCqh-CTpXMS01ZYkM3SNHEU0vHmsVqw_lLrM,4736
+mkdocstrings_matlab-0.9.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+mkdocstrings_matlab-0.9.3.dist-info/licenses/LICENSE,sha256=TZQpwBuA3KLH56--XDAY2Qwo9gGdxeTITYhMOylmYhg,743
+mkdocstrings_matlab-0.9.3.dist-info/RECORD,,