mkdocstrings-matlab 0.1.2__tar.gz → 0.1.4__tar.gz

{mkdocstrings_matlab-0.1.2 → mkdocstrings_matlab-0.1.4}/PKG-INFO

@@ -1,15 +1,17 @@
 Metadata-Version: 2.3
 Name: mkdocstrings-matlab
-Version: 0.1.2
+Version: 0.1.4
 Summary: Add your description here
 Author-email: Mark Hu <mark.hu@asml.com>
 License-File: LICENSE
+Requires-Dist: charset-normalizer>=3.3.2
 Requires-Dist: griffe>=1.2.0
 Requires-Dist: markdown>=3.7
 Requires-Dist: mkdocs-material>=9.5.33
 Requires-Dist: mkdocs>=1.6.0
 Requires-Dist: mkdocstrings>=0.25.2
 Requires-Dist: mkdocstrings[python]>=0.18
+Requires-Dist: textmate-grammar-python>=0.6.1
 Description-Content-Type: text/markdown
 
 # mkdocstrings-matlab

{mkdocstrings_matlab-0.1.2 → mkdocstrings_matlab-0.1.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-matlab"
-version = "0.1.2"
+version = "0.1.4"
 description = "Add your description here"
 authors = [
     { name = "Mark Hu", email = "mark.hu@asml.com" }
@@ -12,6 +12,8 @@ dependencies = [
     "griffe>=1.2.0",
     "mkdocs-material>=9.5.33",
     "markdown>=3.7",
+    "charset-normalizer>=3.3.2",
+    "textmate-grammar-python>=0.6.1",
 ]
 readme = "README.md"
 

mkdocstrings_matlab-0.1.4/src/mkdocstrings_handlers/matlab/collections.py

@@ -0,0 +1,17 @@
+from _griffe.collections import LinesCollection as _LinesCollection, ModulesCollection
+from _griffe.models import Object
+
+
+class LinesCollection(_LinesCollection):
+    pass
+
+
+class ModelsCollection(ModulesCollection):
+    def __init__(self):
+        self.members: dict[str, Object] = {}
+
+    def __setitem__(self, key: str, value: Object):
+        self.members[key] = value
+
+    def __getitem__(self, key: str):
+        return self.members[key]

{mkdocstrings_matlab-0.1.2 → mkdocstrings_matlab-0.1.4}/src/mkdocstrings_handlers/matlab/handler.py

@@ -8,9 +8,11 @@ from griffe import Docstring, Parameters, Parameter, ParameterKind
 from pprint import pprint
 
 
+import charset_normalizer
 import json
 
 
+from mkdocstrings_handlers.matlab.collections import LinesCollection, ModelsCollection
 from mkdocstrings_handlers.matlab_engine import MatlabEngine, MatlabExecutionError
 from mkdocstrings_handlers.matlab.models import (
     Function,
@@ -18,23 +20,9 @@ from mkdocstrings_handlers.matlab.models import (
     Classfolder,
     Namespace,
     Property,
-    ROOT
+    ROOT,
 )
-
-
-class _ModelsStorage:
-    def __init__(self):
-        self._namespace = ""
-        self._models = {}
-
-    def __getitem__(self, key):
-        return self._models[key]
-
-    def __setitem__(self, key, value):
-        self._models[key] = value
-
-    def __contains__(self, key):
-        return key in self._models
+from mkdocstrings_handlers.matlab.parser import MatlabParser
 
 
 class MatlabHandler(BaseHandler):
@@ -72,8 +60,8 @@ class MatlabHandler(BaseHandler):
         # "find_stubs_package": False,
         # "allow_inspection": True,
         "show_bases": True,
-        "show_inheritance_diagram": False,  # not implemented
-        "show_source": False,  # not implemented
+        "show_inheritance_diagram": False,  # Insider feature
+        "show_source": True,
         # "preload_modules": None,
         # Heading options
         "heading_level": 2,
@@ -142,7 +130,9 @@ class MatlabHandler(BaseHandler):
         self.engine = MatlabEngine()
         self.engine.addpath(str(Path(__file__).parent / "matlab"))
         self.engine.matlab_startup(paths, startup_expression)
-        self.models = _ModelsStorage()
+        self.models = ModelsCollection()
+        self.lines = LinesCollection()
+        self.parser = MatlabParser()
         self._locale = locale
 
     def get_templates_dir(self, handler: str | None = None) -> Path:
@@ -173,6 +163,11 @@ class MatlabHandler(BaseHandler):
             raise CollectionError(error.args[0].strip()) from error
         ast_dict = json.loads(ast_json)
 
+        filepath = Path(ast_dict["path"])
+        if filepath not in self.lines:
+            lines = str(charset_normalizer.from_path(filepath).best()).splitlines()
+            self.lines[filepath] = lines
+
         match ast_dict["type"]:
             case "function" | "method":
                 return self.collect_function(ast_dict, final_config)
@@ -255,16 +250,38 @@ class MatlabHandler(BaseHandler):
             if ast_dict["docstring"]
             else None
         )
+
+        filepath = Path(ast_dict["path"])
+
+        if config["show_source"]:
+            tmObject = self.parser.parse_file(filepath)
+            tmClass = next(
+                child
+                for child in tmObject.children
+                if child.token == "meta.class.matlab"
+            )
+        else:
+            tmClass = None
+
+        bases = ast_dict["superclasses"] if isinstance(ast_dict["superclasses"], list) else [ast_dict["superclasses"]]
+        bases = [base for base in bases if base != "handle"]
+
         model = Class(
             ast_dict["name"],
             docstring=docstring,
-            parent=self.get_parent(Path(ast_dict["path"]).parent),
+            parent=self.get_parent(filepath.parent),
             hidden=ast_dict["hidden"],
             sealed=ast_dict["sealed"],
             abstract=ast_dict["abstract"],
             enumeration=ast_dict["enumeration"],
             handle=ast_dict["handle"],
-            filepath=Path(ast_dict["path"]),
+            bases=bases,
+            filepath=filepath,
+            modules_collection=self.models,
+            lines_collection=self.lines,
+            lineno=1,
+            endlineno=len(self.lines[filepath]),
+            textmate=tmClass,
         )
 
         for property_dict in ast_dict["properties"]:
@@ -296,12 +313,14 @@ class MatlabHandler(BaseHandler):
                 continue
 
             method = self.collect(f"{defining_class}.{name}", config)
+            (method.lineno, method.endlineno) = model.get_lineno_method(name)
             method.parent = model
             method._access = method_dict["access"]
             method._static = method_dict["static"]
             method._abstract = method_dict["abstract"]
             method._sealed = method_dict["sealed"]
             method._hidden = method_dict["hidden"]
+
             model.members[name] = method
             self.models[method.canonical_path] = method
 
@@ -340,6 +359,7 @@ class MatlabHandler(BaseHandler):
                 )
             )
 
+        filepath = Path(ast_dict["path"])
         model = Function(
             ast_dict["name"],
             parameters=Parameters(*parameters),
@@ -350,8 +370,12 @@ class MatlabHandler(BaseHandler):
             )
             if ast_dict["docstring"]
             else None,
-            parent=self.get_parent(Path(ast_dict["path"]).parent),
-            filepath=Path(ast_dict["path"]),
+            parent=self.get_parent(filepath.parent),
+            filepath=filepath,
+            modules_collection=self.models,
+            lines_collection=self.lines,
+            lineno=1,
+            endlineno=len(self.lines[filepath]),
         )
 
         self.models[model.canonical_path] = model

{mkdocstrings_matlab-0.1.2 → mkdocstrings_matlab-0.1.4}/src/mkdocstrings_handlers/matlab/matlab/+docstring/+case/class.m

@@ -9,4 +9,4 @@ function data = class(identifier)
     object = metaclass(identifier);
     data = docstring.metadata.class(object);
 
-end
+end

{mkdocstrings_matlab-0.1.2 → mkdocstrings_matlab-0.1.4}/src/mkdocstrings_handlers/matlab/matlab/+docstring/+metadata/argument.m

@@ -11,7 +11,7 @@ function data = argument(object)
            data(iArg) = docstring.metadata.argument(object(iArg));
        end
        return
-    end
+    end 
 
     data.name = object.Name;
     data.kind = string(object.Kind);

{mkdocstrings_matlab-0.1.2 → mkdocstrings_matlab-0.1.4}/src/mkdocstrings_handlers/matlab/matlab/+docstring/+metadata/class.m

@@ -1,6 +1,6 @@
 function data = class(object)
     arguments
-        object (1,1) matlab.metadata.Class
+        object (1,1) % meta.class matlab.metadata.Class
     end
     data.type = 'class';
     
@@ -45,4 +45,4 @@ function data = class(object)
     nameparts = split(object.Name, '.');
     data.constructor = any(strcmp(nameparts(end), [data.methods.name]));
 
-end
+end

{mkdocstrings_matlab-0.1.2 → mkdocstrings_matlab-0.1.4}/src/mkdocstrings_handlers/matlab/matlab/+docstring/+metadata/func.m

@@ -1,7 +1,7 @@
 function data = func(object)
     
     arguments
-        object (1,1) matlab.metadata.MetaData
+        object (1,1) % meta.MetaData matlab.metadata.MetaData
     end
     
     data.type = 'function';

{mkdocstrings_matlab-0.1.2 → mkdocstrings_matlab-0.1.4}/src/mkdocstrings_handlers/matlab/matlab/+docstring/+utils/dedent.m

@@ -7,7 +7,6 @@ end
 
 lines = cellstr(splitlines(doc));
 
-
 for iLine = numel(lines):-1:1
     line = lines{iLine};
     if ~isempty(line) && ~all(line == ' ')

{mkdocstrings_matlab-0.1.2 → mkdocstrings_matlab-0.1.4}/src/mkdocstrings_handlers/matlab/matlab/+docstring/+utils/parse_doc.m

@@ -1,7 +1,7 @@
 function doc = parse_doc(object, combine)
 
 arguments
-    object (1,1) matlab.metadata.MetaData
+    object (1,1) % meta.MetaData matlab.metadata.MetaData
     combine (1,1) logical = true
 end
 

{mkdocstrings_matlab-0.1.2 → mkdocstrings_matlab-0.1.4}/src/mkdocstrings_handlers/matlab/matlab/+docstring/resolve.m

@@ -18,6 +18,10 @@ arguments
     cwd (1,1) string {mustBeFolder} = pwd()
 end
 
+if isempty(identifier)
+    docstring.exception("<empty>");
+end
+
 cd(cwd);
 
 % Check if namespace

{mkdocstrings_matlab-0.1.2 → mkdocstrings_matlab-0.1.4}/src/mkdocstrings_handlers/matlab/models.py

@@ -1,8 +1,8 @@
 from enum import Enum
 from typing import Any
 from griffe import Function as GriffeFunction, Class as GriffeClass, Module, Attribute
-from _griffe.exceptions import BuiltinModuleError
 from pathlib import Path
+from textmate_grammar.elements import ContentElement
 
 
 class Access(Enum):
@@ -43,6 +43,7 @@ class Class(CanonicalPathMixin, PathMixin, GriffeClass):
         abstract: bool = False,
         enumeration: bool = False,
         handle: bool = False,
+        textmate: ContentElement | None = None,
         **kwargs: Any,
     ) -> None:
         super().__init__(*args, **kwargs)
@@ -51,6 +52,31 @@ class Class(CanonicalPathMixin, PathMixin, GriffeClass):
         self._abstract: bool = abstract
         self._enumeration: bool = enumeration
         self._handle: bool = handle
+        self._textmate: ContentElement | None = textmate
+
+        self._method_lineno: dict[str, tuple[int, int]] = {}
+        if textmate is None:
+            return
+        for block in [
+            block
+            for block in self._textmate.children
+            if block.token == "meta.methods.matlab"
+        ]:
+            for method in block.children:
+                declaration = next(
+                    item
+                    for item in method.children
+                    if item.token == "meta.function.declaration.matlab"
+                )
+                name = next(
+                    item
+                    for item in declaration.children
+                    if item.token == "entity.name.function.matlab"
+                ).content
+                charaters_ids = method.characters.keys()
+                lineno = min(charaters_ids, key=lambda p: p[0])[0]
+                endlino = max(charaters_ids, key=lambda p: p[0])[0] + 1
+                self._method_lineno[name] = (lineno, endlino)
 
     @property
     def is_private(self) -> bool:
@@ -63,6 +89,9 @@ class Class(CanonicalPathMixin, PathMixin, GriffeClass):
         else:
             return super().canonical_path
 
+    def get_lineno_method(self, method_name: str) -> tuple[int, int]:
+        return self._method_lineno.get(method_name, (self.lineno, self.endlineno))
+
 
 class Property(CanonicalPathMixin, Attribute):
     def __init__(
@@ -137,7 +166,7 @@ class _Root(Namespace):
 
     def __repr__(self) -> str:
         return "MATLABROOT"
-    
+
 
 ROOT = _Root()
 
@@ -145,7 +174,3 @@ ROOT = _Root()
 class Classfolder(Class):
     def __repr__(self) -> str:
         return f"Classfolder({self.path!r})"
-
-
-
-

mkdocstrings_matlab-0.1.4/src/mkdocstrings_handlers/matlab/parser.py

@@ -0,0 +1,31 @@
+from textmate_grammar.parsers.base import LanguageParser
+from pathlib import Path
+
+
+import logging
+import yaml
+
+
+logging.getLogger("textmate_grammar").setLevel(logging.ERROR)
+
+
+class MatlabParser(LanguageParser):
+    """
+    Represents a grammar for the MATLAB language.
+    """
+
+    def __init__(self, **kwargs):
+        """
+        Initializes a new instance of the MatlabGrammar class.
+
+        Args:
+            remove_line_continuations (bool, optional): Whether to remove line continuations. Defaults to False.
+        """
+
+        with open(Path(__file__).parent / "resources" / "grammar.yml") as file:
+            try:
+                grammar = yaml.load(file.read(), Loader=yaml.CLoader)
+            except ImportError:
+                grammar = yaml.load(file.read(), Loader=yaml.Loader)
+
+        super().__init__(grammar, **kwargs)