Support class methods, properties, and static methods on deftype* (#378)

* Support class methods, properties, and static methods on `deftype*`

* Remove references to record and type

* Add lots of tests

* Testssss

* Static method tests

* Class method tests

* Test for disallowing a method to be multiple types

* Disallow recur forms in class and static methods

* Do not consider classmethod cls argument as LocalType.THIS

* Add symbol table for property

* Correct recur assertion

* Remove unused _assert_recur_is_tail branch

Author: chrisrink10

src/basilisp/lang/compiler/constants.py

@@ -28,13 +28,121 @@ class SpecialForm:
 
 DEFAULT_COMPILER_FILE_PATH = "NO_SOURCE_PATH"
 
+# Trimmed list of __dunder__ methods generated by using this command:
+#
+#     find "$(pipenv --venv)/lib/python3.6" \
+#          -name '*.py' \
+#          -exec egrep \
+#          -oh '__[A-Za-z_][A-Za-z_0-9]*__' '{}' \; \
+#          | sort | uniq
+OBJECT_DUNDER_METHODS = frozenset(
+    {
+        "__abs__",
+        "__add__",
+        "__aenter__",
+        "__aexit__",
+        "__aiter__",
+        "__await__",
+        "__bytes__",
+        "__call__",
+        "__complex__",
+        "__contains__",
+        "__del__",
+        "__delattr__",
+        "__delitem__",
+        "__delslice__",
+        "__dict__",
+        "__dir__",
+        "__div__",
+        "__divmod__",
+        "__enter__",
+        "__eq__",
+        "__exit__",
+        "__float__",
+        "__floordiv__",
+        "__ge__",
+        "__getattr__",
+        "__getattribute__",
+        "__getitem__",
+        "__getslice__",
+        "__getstate__",
+        "__gt__",
+        "__hash__",
+        "__iadd__",
+        "__iand__",
+        "__idiv__",
+        "__ifloordiv__",
+        "__ilshift__",
+        "__imatmul__",
+        "__imod__",
+        "__imul__",
+        "__init__",
+        "__instancecheck__",
+        "__int__",
+        "__invert__",
+        "__ior__",
+        "__ipow__",
+        "__isub__",
+        "__iter__",
+        "__itruediv__",
+        "__ixor__",
+        "__le__",
+        "__len__",
+        "__lshift__",
+        "__matmul__",
+        "__mod__",
+        "__mul__",
+        "__ne__",
+        "__neg__",
+        "__new__",
+        "__not__",
+        "__pos__",
+        "__pow__",
+        "__radd__",
+        "__rand__",
+        "__rcmp__",
+        "__rdiv__",
+        "__rdivmod__",
+        "__reduce__",
+        "__reduce_ex__",
+        "__repr__",
+        "__rfloordiv__",
+        "__rlshift__",
+        "__rmatmul__",
+        "__rmod__",
+        "__rmul__",
+        "__rne__",
+        "__ror__",
+        "__round__",
+        "__rpow__",
+        "__rrshift__",
+        "__rshift__",
+        "__rsub__",
+        "__rtruediv__",
+        "__rxor__",
+        "__setattr__",
+        "__setitem__",
+        "__setslice__",
+        "__setstate__",
+        "__str__",
+        "__sub__",
+        "__subclasscheck__",
+        "__subclasshook__",
+        "__truediv__",
+        "__xor__",
+    }
+)
+
 SYM_ASYNC_META_KEY = kw.keyword("async")
+SYM_CLASSMETHOD_META_KEY = kw.keyword("classmethod")
 SYM_DYNAMIC_META_KEY = kw.keyword("dynamic")
+SYM_PROPERTY_META_KEY = kw.keyword("property")
 SYM_MACRO_META_KEY = kw.keyword("macro")
 SYM_MUTABLE_META_KEY = kw.keyword("mutable")
 SYM_NO_WARN_ON_REDEF_META_KEY = kw.keyword("no-warn-on-redef")
 SYM_NO_WARN_WHEN_UNUSED_META_KEY = kw.keyword("no-warn-when-unused")
 SYM_REDEF_META_KEY = kw.keyword("redef")
+SYM_STATICMETHOD_META_KEY = kw.keyword("staticmethod")
 
 ARGLISTS_KW = kw.keyword("arglists")
 COL_KW = kw.keyword("col")

src/basilisp/lang/compiler/generator.py

@@ -49,10 +49,12 @@
     Await,
     Binding,
     Catch,
+    ClassMethod,
     Const,
     ConstType,
     Def,
     DefType,
+    DefTypeMember,
     Do,
     Fn,
     FnMethod,
@@ -72,6 +74,7 @@
     Node,
     NodeEnv,
     NodeOp,
+    PropertyMethod,
     PyDict,
     PyList,
     PySet,
@@ -81,6 +84,7 @@
     Recur,
     Set as SetNode,
     SetBang,
+    StaticMethod,
     Throw,
     Try,
     VarRef,
@@ -484,6 +488,9 @@ def _is_redefable(v: Var) -> bool:
 _COERCE_SEQ_FN_NAME = _load_attr(f"{_RUNTIME_ALIAS}.to_seq")
 _BASILISP_FN_FN_NAME = _load_attr(f"{_RUNTIME_ALIAS}._basilisp_fn")
 _FN_WITH_ATTRS_FN_NAME = _load_attr(f"{_RUNTIME_ALIAS}._with_attrs")
+_PY_CLASSMETHOD_FN_NAME = _load_attr("classmethod")
+_PY_PROPERTY_FN_NAME = _load_attr("property")
+_PY_STATICMETHOD_FN_NAME = _load_attr("staticmethod")
 _TRAMPOLINE_FN_NAME = _load_attr(f"{_RUNTIME_ALIAS}._trampoline")
 _TRAMPOLINE_ARGS_FN_NAME = _load_attr(f"{_RUNTIME_ALIAS}._TrampolineArgs")
 
@@ -705,9 +712,76 @@ def _def_to_py_ast(  # pylint: disable=too-many-branches
 
 
 @_with_ast_loc
-def __deftype_method_to_py_ast(  # pylint: disable=too-many-branches
-    ctx: GeneratorContext, node: Method
+def __deftype_classmethod_to_py_ast(
+    ctx: GeneratorContext, node: ClassMethod
 ) -> GeneratedPyAST:
+    assert node.op == NodeOp.CLASS_METHOD
+    method_name = munge(node.name)
+
+    with ctx.new_symbol_table(node.name):
+        class_name = genname(munge(node.class_local.name))
+        class_sym = sym.symbol(node.class_local.name)
+        ctx.symbol_table.new_symbol(class_sym, class_name, LocalType.ARG)
+
+        fn_args, varg, fn_body_ast = __fn_args_to_py_ast(ctx, node.params, node.body)
+        return GeneratedPyAST(
+            node=ast.FunctionDef(
+                name=method_name,
+                args=ast.arguments(
+                    args=list(
+                        chain([ast.arg(arg=class_name, annotation=None)], fn_args)
+                    ),
+                    kwarg=None,
+                    vararg=varg,
+                    kwonlyargs=[],
+                    defaults=[],
+                    kw_defaults=[],
+                ),
+                body=fn_body_ast,
+                decorator_list=[_PY_CLASSMETHOD_FN_NAME],
+                returns=None,
+            )
+        )
+
+
+@_with_ast_loc
+def __deftype_property_to_py_ast(
+    ctx: GeneratorContext, node: PropertyMethod
+) -> GeneratedPyAST:
+    assert node.op == NodeOp.PROPERTY_METHOD
+    method_name = munge(node.name)
+
+    with ctx.new_symbol_table(node.name):
+        this_name = genname(munge(node.this_local.name))
+        this_sym = sym.symbol(node.this_local.name)
+        ctx.symbol_table.new_symbol(this_sym, this_name, LocalType.THIS)
+
+        with ctx.new_this(this_sym):
+            fn_args, varg, fn_body_ast = __fn_args_to_py_ast(
+                ctx, node.params, node.body
+            )
+            return GeneratedPyAST(
+                node=ast.FunctionDef(
+                    name=method_name,
+                    args=ast.arguments(
+                        args=list(
+                            chain([ast.arg(arg=this_name, annotation=None)], fn_args)
+                        ),
+                        kwarg=None,
+                        vararg=varg,
+                        kwonlyargs=[],
+                        defaults=[],
+                        kw_defaults=[],
+                    ),
+                    body=fn_body_ast,
+                    decorator_list=[_PY_PROPERTY_FN_NAME],
+                    returns=None,
+                )
+            )
+
+
+@_with_ast_loc
+def __deftype_method_to_py_ast(ctx: GeneratorContext, node: Method) -> GeneratedPyAST:
     assert node.op == NodeOp.METHOD
     method_name = munge(node.name)
 
@@ -744,6 +818,52 @@ def __deftype_method_to_py_ast(  # pylint: disable=too-many-branches
             )
 
 
+@_with_ast_loc
+def __deftype_staticmethod_to_py_ast(
+    ctx: GeneratorContext, node: StaticMethod
+) -> GeneratedPyAST:
+    assert node.op == NodeOp.STATIC_METHOD
+    method_name = munge(node.name)
+
+    with ctx.new_symbol_table(node.name):
+        fn_args, varg, fn_body_ast = __fn_args_to_py_ast(ctx, node.params, node.body)
+        return GeneratedPyAST(
+            node=ast.FunctionDef(
+                name=method_name,
+                args=ast.arguments(
+                    args=list(fn_args),
+                    kwarg=None,
+                    vararg=varg,
+                    kwonlyargs=[],
+                    defaults=[],
+                    kw_defaults=[],
+                ),
+                body=fn_body_ast,
+                decorator_list=[_PY_STATICMETHOD_FN_NAME],
+                returns=None,
+            )
+        )
+
+
+_DEFTYPE_MEMBER_HANDLER: Mapping[NodeOp, PyASTGenerator] = {
+    NodeOp.CLASS_METHOD: __deftype_classmethod_to_py_ast,
+    NodeOp.METHOD: __deftype_method_to_py_ast,
+    NodeOp.PROPERTY_METHOD: __deftype_property_to_py_ast,
+    NodeOp.STATIC_METHOD: __deftype_staticmethod_to_py_ast,
+}
+
+
+def __deftype_member_to_py_ast(
+    ctx: GeneratorContext, node: DefTypeMember
+) -> GeneratedPyAST:
+    member_type = node.op
+    handle_deftype_member = _DEFTYPE_MEMBER_HANDLER.get(member_type)
+    assert (
+        handle_deftype_member is not None
+    ), f"Invalid :const AST type handler for {member_type}"
+    return handle_deftype_member(ctx, node)
+
+
 @_with_ast_loc
 def _deftype_to_py_ast(  # pylint: disable=too-many-branches
     ctx: GeneratorContext, node: DefType
@@ -784,9 +904,9 @@ def _deftype_to_py_ast(  # pylint: disable=too-many-branches
             ctx.symbol_table.new_symbol(sym.symbol(field.name), safe_field, field.local)
 
         type_deps: List[ast.AST] = []
-        for method in node.methods:
-            type_ast = __deftype_method_to_py_ast(ctx, method)
-            type_nodes.append(type_ast.node)
+        for member in node.members:
+            type_ast = __deftype_member_to_py_ast(ctx, member)
+            type_nodes.append(type_ast.node)  # type: ignore
             type_deps.extend(type_ast.dependencies)
 
         return GeneratedPyAST(
@@ -1870,7 +1990,11 @@ def _var_sym_to_py_ast(
     if safe_name in ns_module.__dict__:
         if ns is ctx.current_ns:
             return GeneratedPyAST(node=ast.Name(id=safe_name, ctx=py_var_ctx))
-        return GeneratedPyAST(node=_load_attr(f"{safe_ns}.{safe_name}", ctx=py_var_ctx))
+        return GeneratedPyAST(
+            node=_load_attr(
+                f"{_MODULE_ALIASES.get(ns_name, safe_ns)}.{safe_name}", ctx=py_var_ctx
+            )
+        )
 
     if ctx.warn_on_var_indirection:
         logger.warning(f"could not resolve a direct link to Var '{var_name}'")
@@ -1930,10 +2054,7 @@ def _maybe_class_to_py_ast(_: GeneratorContext, node: MaybeClass) -> GeneratedPy
     variable name."""
     assert node.op == NodeOp.MAYBE_CLASS
     return GeneratedPyAST(
-        node=ast.Name(
-            id=Maybe(_MODULE_ALIASES.get(node.class_)).or_else_get(node.class_),
-            ctx=ast.Load(),
-        )
+        node=ast.Name(id=_MODULE_ALIASES.get(node.class_, node.class_), ctx=ast.Load())
     )
 
 
@@ -1945,9 +2066,7 @@ def _maybe_host_form_to_py_ast(
     variable name with a namespace."""
     assert node.op == NodeOp.MAYBE_HOST_FORM
     return GeneratedPyAST(
-        node=_load_attr(
-            f"{Maybe(_MODULE_ALIASES.get(node.class_)).or_else_get(node.class_)}.{node.field}"
-        )
+        node=_load_attr(f"{_MODULE_ALIASES.get(node.class_, node.class_)}.{node.field}")
     )
 
 
@@ -2373,7 +2492,9 @@ def _collection_literal_to_py_ast(
     ConstType.KEYWORD: _kw_to_py_ast,
     ConstType.MAP: _const_map_to_py_ast,
     ConstType.SET: _const_set_to_py_ast,
+    ConstType.RECORD: None,
     ConstType.SEQ: _const_seq_to_py_ast,
+    ConstType.TYPE: None,
     ConstType.REGEX: _regex_to_py_ast,
     ConstType.SYMBOL: _const_sym_to_py_ast,
     ConstType.STRING: _str_to_py_ast,