Typed Basilisp module (#482)

* Typed Basilisp module

* Change the log

Author: chrisrink10

CHANGELOG.md

@@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
  * Change the default user namespace to `basilisp.user` (#466)
  * Changed multi-methods to use a `threading.Lock` internally rather than an Atom (#478)
+ * Changed the Basilisp module type from `types.ModuleType` to a custom subtype with support for custom attributes (#482)
 
 ### Fixed
  * Fixed a reader bug where no exception was being thrown splicing reader conditional forms appeared outside of valid splicing contexts (#470)

src/basilisp/cli.py

@@ -11,6 +11,7 @@
 import basilisp.lang.runtime as runtime
 import basilisp.lang.symbol as sym
 import basilisp.main as basilisp
+from basilisp.lang.typing import BasilispModule
 from basilisp.prompt import get_prompter
 
 CLI_INPUT_FILE_PATH = "<CLI Input>"
@@ -24,7 +25,7 @@ def cli():
     """Basilisp is a Lisp dialect inspired by Clojure targeting Python 3."""
 
 
-def eval_file(filename: str, ctx: compiler.CompilerContext, module: types.ModuleType):
+def eval_file(filename: str, ctx: compiler.CompilerContext, module: BasilispModule):
     """Evaluate a file with the given name into a Python module AST node."""
     last = None
     for form in reader.read_file(filename, resolver=runtime.resolve_alias):
@@ -33,7 +34,7 @@ def eval_file(filename: str, ctx: compiler.CompilerContext, module: types.Module
     return last
 
 
-def eval_stream(stream, ctx: compiler.CompilerContext, module: types.ModuleType):
+def eval_stream(stream, ctx: compiler.CompilerContext, module: BasilispModule):
     """Evaluate the forms in stdin into a Python module AST node."""
     last = None
     for form in reader.read(stream, resolver=runtime.resolve_alias):
@@ -42,7 +43,7 @@ def eval_stream(stream, ctx: compiler.CompilerContext, module: types.ModuleType)
     return last
 
 
-def eval_str(s: str, ctx: compiler.CompilerContext, module: types.ModuleType, eof: Any):
+def eval_str(s: str, ctx: compiler.CompilerContext, module: BasilispModule, eof: Any):
     """Evaluate the forms in a string into a Python module AST node."""
     last = eof
     for form in reader.read_str(s, resolver=runtime.resolve_alias, eof=eof):

src/basilisp/importer.py

@@ -13,7 +13,7 @@
 import basilisp.lang.compiler as compiler
 import basilisp.lang.reader as reader
 import basilisp.lang.runtime as runtime
-from basilisp.lang.typing import ReaderForm
+from basilisp.lang.typing import BasilispModule, ReaderForm
 from basilisp.lang.util import demunge
 from basilisp.util import timed
 
@@ -219,7 +219,7 @@ def get_filename(self, fullname: str) -> str:  # pragma: no cover
 
     def create_module(self, spec: ModuleSpec):
         logger.debug(f"Creating Basilisp module '{spec.name}''")
-        mod = types.ModuleType(spec.name)
+        mod = BasilispModule(spec.name)
         mod.__file__ = spec.loader_state["filename"]
         mod.__loader__ = spec.loader
         mod.__package__ = spec.parent
@@ -232,7 +232,7 @@ def _exec_cached_module(
         fullname: str,
         loader_state: Mapping[str, str],
         path_stats: Mapping[str, int],
-        module: types.ModuleType,
+        module: BasilispModule,
     ):
         """Load and execute a cached Basilisp module."""
         filename = loader_state["filename"]
@@ -260,7 +260,7 @@ def _exec_module(
         fullname: str,
         loader_state: Mapping[str, str],
         path_stats: Mapping[str, int],
-        module: types.ModuleType,
+        module: BasilispModule,
     ):
         """Load and execute a non-cached Basilisp module."""
         filename = loader_state["filename"]
@@ -307,6 +307,8 @@ def exec_module(self, module):
         each form in a module may require code compiled from an earlier form, so
         we incrementally compile a Python module by evaluating a single top-level
         form at a time and inserting the resulting AST nodes into the Pyton module."""
+        assert isinstance(module, BasilispModule)
+
         fullname = module.__name__
         cached = self._cache[fullname]
         cached["module"] = module

src/basilisp/lang/compiler/__init__.py

@@ -28,7 +28,7 @@
     statementize as _statementize,
 )
 from basilisp.lang.compiler.optimizer import PythonASTOptimizer
-from basilisp.lang.typing import ReaderForm
+from basilisp.lang.typing import BasilispModule, ReaderForm
 from basilisp.lang.util import genname
 
 _DEFAULT_FN = "__lisp_expr__"
@@ -89,7 +89,7 @@ def _emit_ast_string(module: ast.AST) -> None:  # pragma: no cover
 def compile_and_exec_form(  # pylint: disable= too-many-arguments
     form: ReaderForm,
     ctx: CompilerContext,
-    module: types.ModuleType,
+    module: BasilispModule,
     wrapped_fn_name: str = _DEFAULT_FN,
     collect_bytecode: Optional[BytecodeCollector] = None,
 ) -> Any:
@@ -101,7 +101,7 @@ def compile_and_exec_form(  # pylint: disable= too-many-arguments
     if form is None:
         return None
 
-    if not module.__basilisp_bootstrapped__:  # type: ignore
+    if not module.__basilisp_bootstrapped__:
         _bootstrap_module(ctx.generator_context, ctx.py_ast_optimizer, module)
 
     final_wrapped_name = genname(wrapped_fn_name)
@@ -134,7 +134,7 @@ def compile_and_exec_form(  # pylint: disable= too-many-arguments
 def _incremental_compile_module(
     optimizer: PythonASTOptimizer,
     py_ast: GeneratedPyAST,
-    mod: types.ModuleType,
+    mod: BasilispModule,
     source_filename: str,
     collect_bytecode: Optional[BytecodeCollector] = None,
 ) -> None:
@@ -163,7 +163,7 @@ def _incremental_compile_module(
 def _bootstrap_module(
     gctx: GeneratorContext,
     optimizer: PythonASTOptimizer,
-    mod: types.ModuleType,
+    mod: BasilispModule,
     collect_bytecode: Optional[BytecodeCollector] = None,
 ) -> None:
     """Bootstrap a new module with imports and other boilerplate."""
@@ -174,13 +174,13 @@ def _bootstrap_module(
         source_filename=gctx.filename,
         collect_bytecode=collect_bytecode,
     )
-    mod.__basilisp_bootstrapped__ = True  # type: ignore
+    mod.__basilisp_bootstrapped__ = True
 
 
 def compile_module(
     forms: Iterable[ReaderForm],
     ctx: CompilerContext,
-    module: types.ModuleType,
+    module: BasilispModule,
     collect_bytecode: Optional[BytecodeCollector] = None,
 ) -> None:
     """Compile an entire Basilisp module into Python bytecode which can be
@@ -209,7 +209,7 @@ def compile_bytecode(
     code: List[types.CodeType],
     gctx: GeneratorContext,
     optimizer: PythonASTOptimizer,
-    module: types.ModuleType,
+    module: BasilispModule,
 ) -> None:
     """Compile cached bytecode into the given module.
 

src/basilisp/lang/compiler/generator.py

@@ -3,7 +3,6 @@
 import importlib
 import logging
 import re
-import types
 import uuid
 from datetime import datetime
 from decimal import Decimal
@@ -257,11 +256,11 @@ def new_symbol_table(self, name):
             yield st
             self._st.pop()
 
-    def add_import(self, imp: sym.Symbol, mod: types.ModuleType, *aliases: sym.Symbol):
+    def add_import(self, imp: sym.Symbol, mod: runtime.Module, *aliases: sym.Symbol):
         self.current_ns.add_import(imp, mod, *aliases)
 
     @property
-    def imports(self) -> lmap.Map[sym.Symbol, types.ModuleType]:
+    def imports(self) -> runtime.ModuleMap:
         return self.current_ns.imports
 
     @property
@@ -2790,8 +2789,8 @@ def _module_imports(ctx: GeneratorContext) -> Iterable[ast.Import]:
     # Yield `import basilisp` so code attempting to call fully qualified
     # `basilisp.lang...` modules don't result in compiler errors
     yield ast.Import(names=[ast.alias(name="basilisp", asname=None)])
-    for imp in ctx.imports:
-        name = imp.key.name
+    for s in sorted(ctx.imports.keys(), key=lambda s: s.name):
+        name = s.name
         alias = _MODULE_ALIASES.get(name, None)
         yield ast.Import(names=[ast.alias(name=name, asname=alias)])
 

src/basilisp/lang/runtime.py

@@ -46,7 +46,7 @@
     ISeqable,
 )
 from basilisp.lang.reference import ReferenceBase
-from basilisp.lang.typing import LispNumber
+from basilisp.lang.typing import BasilispModule, LispNumber
 from basilisp.lang.util import munge
 from basilisp.logconfig import TRACE
 from basilisp.util import Maybe
@@ -121,14 +121,14 @@
 CompletionTrimmer = Callable[[Tuple[sym.Symbol, Any]], str]
 
 
-def _new_module(name: str, doc=None) -> types.ModuleType:
+def _new_module(name: str, doc=None) -> BasilispModule:
     """Create a new empty Basilisp Python module.
     Modules are created for each Namespace when it is created."""
-    mod = types.ModuleType(name, doc=doc)
+    mod = BasilispModule(name, doc=doc)
     mod.__loader__ = None
     mod.__package__ = None
     mod.__spec__ = None
-    mod.__basilisp_bootstrapped__ = False  # type: ignore
+    mod.__basilisp_bootstrapped__ = False
     return mod
 
 
@@ -338,7 +338,8 @@ def pop_bindings(self):
 
 
 AliasMap = lmap.Map[sym.Symbol, sym.Symbol]
-ModuleMap = lmap.Map[sym.Symbol, types.ModuleType]
+Module = Union[BasilispModule, types.ModuleType]
+ModuleMap = lmap.Map[sym.Symbol, Module]
 NamespaceMap = lmap.Map[sym.Symbol, "Namespace"]
 VarMap = lmap.Map[sym.Symbol, Var]
 
@@ -416,7 +417,7 @@ class Namespace(ReferenceBase):
         "_import_aliases",
     )
 
-    def __init__(self, name: sym.Symbol, module: types.ModuleType = None) -> None:
+    def __init__(self, name: sym.Symbol, module: BasilispModule = None) -> None:
         self._name = name
         self._module = Maybe(module).or_else(lambda: _new_module(name.as_python_sym()))
 
@@ -452,11 +453,11 @@ def name(self) -> str:
         return self._name.name
 
     @property
-    def module(self) -> types.ModuleType:
+    def module(self) -> BasilispModule:
         return self._module
 
     @module.setter
-    def module(self, m: types.ModuleType):
+    def module(self, m: BasilispModule):
         """Override the Python module for this Namespace.
 
         ***WARNING**
@@ -543,9 +544,7 @@ def find(self, sym: sym.Symbol) -> Optional[Var]:
             return self.refers.val_at(sym, None)
         return v
 
-    def add_import(
-        self, sym: sym.Symbol, module: types.ModuleType, *aliases: sym.Symbol
-    ) -> None:
+    def add_import(self, sym: sym.Symbol, module: Module, *aliases: sym.Symbol) -> None:
         """Add the Symbol as an imported Symbol in this Namespace. If aliases are given,
         the aliases will be applied to the """
         self._imports.swap(lambda m: m.assoc(sym, module))
@@ -556,7 +555,7 @@ def add_import(
                 )
             )
 
-    def get_import(self, sym: sym.Symbol) -> Optional[types.ModuleType]:
+    def get_import(self, sym: sym.Symbol) -> Optional[BasilispModule]:
         """Return the module if a moduled named by sym has been imported into
         this Namespace, None otherwise.
 
@@ -603,7 +602,7 @@ def ns_cache(cls) -> lmap.Map:
     def __get_or_create(
         ns_cache: NamespaceMap,
         name: sym.Symbol,
-        module: types.ModuleType = None,
+        module: BasilispModule = None,
         core_ns_name=CORE_NS,
     ) -> lmap.Map:
         """Private swap function used by `get_or_create` to atomically swap
@@ -620,7 +619,7 @@ def __get_or_create(
 
     @classmethod
     def get_or_create(
-        cls, name: sym.Symbol, module: types.ModuleType = None
+        cls, name: sym.Symbol, module: BasilispModule = None
     ) -> "Namespace":
         """Get the namespace bound to the symbol `name` in the global namespace
         cache, creating it if it does not exist.
@@ -1396,7 +1395,7 @@ def init_ns_var(which_ns: str = CORE_NS, ns_var_name: str = NS_VAR_NAME) -> Var:
 
 def set_current_ns(
     ns_name: str,
-    module: types.ModuleType = None,
+    module: BasilispModule = None,
     ns_var_name: str = NS_VAR_NAME,
     ns_var_ns: str = NS_VAR_NS,
 ) -> Var:
@@ -1417,7 +1416,7 @@ def set_current_ns(
 @contextlib.contextmanager
 def ns_bindings(
     ns_name: str,
-    module: types.ModuleType = None,
+    module: BasilispModule = None,
     ns_var_name: str = NS_VAR_NAME,
     ns_var_ns: str = NS_VAR_NS,
 ):

src/basilisp/lang/typing.py

@@ -2,6 +2,7 @@
 from datetime import datetime
 from decimal import Decimal
 from fractions import Fraction
+from types import ModuleType
 from typing import Pattern, Union
 
 import basilisp.lang.keyword as kw
@@ -36,3 +37,7 @@
 PyCollectionForm = Union[dict, list, set, tuple]
 ReaderForm = Union[LispForm, IRecord, ISeq, IType, PyCollectionForm]
 SpecialForm = Union[llist.List, ISeq]
+
+
+class BasilispModule(ModuleType):
+    __basilisp_bootstrapped__: bool = False