Merge pull request #2680 from Kodiologist/misc

Miscellany

Author: Kodiologist

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2025 the authors.
+Copyright 2026 the authors.
 Portions of setup.py, copyright 2016 Jason R Coombs <[email protected]>.
 
 Permission is hereby granted, free of charge, to any person obtaining a

README.md

@@ -0,0 +1,43 @@
+Hy
+==
+
+.. image:: https://img.shields.io/pypi/v/hy.svg
+   :target: https://pypi.python.org/pypi/hy
+   :alt: Version
+
+.. image:: https://raw.github.com/hylang/shyte/18f6925e08684b0e1f52b2cc2c803989cd62cd91/imgs/xkcd.png
+   :target: https://xkcd.com/224/
+   :alt: XKCD #224
+
+.. comment
+   :title: We lost the documentation on quantum mechanics. You'll have to decode the regexes yourself.
+
+Lisp and Python should love each other. Let's make it happen.
+
+Hy is a Lisp dialect that's embedded in Python. Since Hy transforms its Lisp
+code into Python abstract syntax tree (AST) objects, you have the whole
+beautiful world of Python at your fingertips, in Lisp form.
+
+To install the latest release of Hy, just use the command ``pip3 install
+--user hy``. Then you can start an interactive read-eval-print loop (REPL) with
+the command ``hy``, or run a Hy program with ``hy myprogram.hy``.
+
+* `The Hy homepage <http://hylang.org>`__
+* `Try Hy with a web console <http://hylang.org/try-hy>`__
+
+Project
+-------
+
+* Code: https://github.com/hylang/hy
+* Documentation: http://hylang.org/hy/doc
+* Bug reports: We have no bugs! Your bugs are your own! (https://github.com/hylang/hy/issues)
+* License: MIT (Expat)
+* Community: Join us on `Github Discussions <https://github.com/hylang/hy/discussions>`__
+* `Stack Overflow: The [hy] tag <https://stackoverflow.com/questions/tagged/hy>`__
+
+Hy's current maintainer is `Kodi Arfer <https://github.com/Kodiologist>`__. He takes responsibility for answering user questions, which should primarily be asked on Stack Overflow or GitHub Discussions, but feel free to `poke him <http://arfer.net/elsewhere>`__ if he's missed a question or you've found a serious security issue.
+
+.. image:: https://i.imgur.com/QbPMXTN.png
+   :alt: Cuddles the Hacker
+
+(fan art from the one and only `doctormo <http://doctormo.deviantart.com/art/Cuddles-the-Hacker-372184766>`__)

README.rst

@@ -38,29 +38,6 @@ def rewriting_unparse(ast_obj):
     ast.unparse = rewriting_unparse
 
 
-if True:
-    import pydoc, inspect, re
-    true_getdoc = pydoc.getdoc
-    def getdoc(object):
-        """A monkey-patched `pydoc.getdoc` that tries to avoid calling
-        `inspect.getcomments` for an object defined in Hy code, which would try
-        to parse the Hy as Python. The implementation is based on Python
-        3.12.3's `getdoc`."""
-        result = pydoc._getdoc(object)
-        if not result:
-            can_get_comments = True
-            try:
-                file_path = inspect.getfile(object)
-            except TypeError:
-                None
-            else:
-                can_get_comments = not file_path.endswith('.hy')
-            if can_get_comments:
-                result = inspect.getcomments(object)
-        return result and re.sub('^ *\n', '', result.rstrip()) or ''
-    pydoc.getdoc = getdoc
-
-
 def reu(x):
     '(R)eplace an (e)rror (u)nderline. This is only used for testing Hy.'
     return x.replace('-', '^') if PY3_13 else x

hy/compat.py

@@ -37,22 +37,6 @@
 from hy.reader import mangle, HyReader
 from hy.scoping import ResolveOuterVars, ScopeGlobal
 
-hy_ast_compile_flags = 0
-
-
-def ast_compile(a, filename, mode):
-    """Compile AST.
-
-    Args:
-        a (ast.AST): instance of `ast.AST`
-        filename (str): Filename used for run-time error messages
-        mode (str): `compile` mode parameter
-
-    Returns:
-        types.CodeType: instance of `types.CodeType`
-    """
-    return compile(a, filename, mode, hy_ast_compile_flags)
-
 
 def calling_module(n=1):
     """Get the module calling, if available.
@@ -766,10 +750,10 @@ def hy_eval(
         globals = module.__dict__
 
     # Two-step eval: eval() the body of the exec call
-    eval(ast_compile(_ast, filename, "exec"), globals, locals)
+    eval(compile(_ast, filename, "exec"), globals, locals)
 
     # Then eval the expression context and return that
-    return eval(ast_compile(expr, filename, "eval"), globals, locals)
+    return eval(compile(expr, filename, "eval"), globals, locals)
 
 
 def hy_eval_user(model, globals = None, locals = None, module = None, macros = None):

hy/compiler.py

@@ -10,6 +10,7 @@
 
 import os
 
+from pathlib import Path
 from setuptools import find_packages, setup
 from setuptools.command.install import install
 
@@ -56,7 +57,8 @@ def run(self):
     },
     author="Paul Tagliamonte",
     author_email="[email protected]",
-    long_description=long_description,
+    long_description=Path('README.rst').read_text(),
+    long_description_content_type='text/x-rst',
     description="A Lisp dialect embedded in Python",
     license="Expat",
     url="http://hylang.org/",

setup.py

@@ -6,7 +6,8 @@
   importlib
   pydoc
   pytest
-  hy.errors [HyLanguageError HySyntaxError])
+  hy.errors [HyLanguageError HySyntaxError]
+  hy.compat [PY3_13])
 
 
 (defn test-pragma-hy []
@@ -99,14 +100,15 @@
   (importlib.invalidate-caches)
   (import pydoc-hy)
   (assert (= (pydoc.getdoc pydoc-hy.C1) "C1 docstring"))
-  (assert (= (pydoc.getdoc pydoc-hy.C2) "")))
-    ; `pydoc` shouldn't try to get a comment from Hy code, since it
-    ; doesn't know how to parse Hy.
+  (assert (= (pydoc.getdoc pydoc-hy.C2) (if PY3_13
+    ; Class location via Hy isn't implemented on earlier Pythons.
+    "; a comment"
+    ""))))
 
 
 (defn test-help-class-attr []
-  "Our tampering with `pydoc` shouldn't cause `help` to raise
-  `TypeError` on classes with non-method attributes."
+  "Our tampering with `pydoc` or `inspect` shouldn't cause `help` to
+  raise `TypeError` on classes with non-method attributes."
   (defclass C []
     (setv attribute 1))
   (help C))

tests/native_tests/other.hy

@@ -10,7 +10,7 @@
 from importlib.util import cache_from_source
 from pathlib import Path
 
-from hy.compat import PY3_13
+from hy.compat import PY3_10, PY3_13
 
 import pytest
 
@@ -447,9 +447,10 @@ def test_traceback_shebang(tmp_path):
     assert '(/ 1 0)' in error
 
 
-@pytest.mark.xfail(not PY3_13, reason = 'likely Hy bug in line-number assignment')
+@pytest.mark.xfail(not PY3_10, reason = 'not worth debugging, since CPython 3.9 is unmaintained and this is a minor, undocumented feature')
 def test_pdb_ll(tmp_path):
     # Test the Python debugger's `ll` command.
+
     p = tmp_path / 'ex.hy'
     p.write_text(str.strip(dedent('''
         (defn f []
@@ -458,20 +459,27 @@ def test_pdb_ll(tmp_path):
           (print (.upper "bbb")))
         (f)''')))
     o, _ = run_cmd(['hy', p], 'll\nquit\n', expect = 1)
+
     assert 'AAA' in o
     assert 'BBB' not in o
-    got = re.sub(r'\s+', ' ', o).strip()
-    expect = re.sub(r'\s+', ' ', f'''
-        ex.hy(3)f()
-        -> (breakpoint)
-        (Pdb) 1   (defn f []
-          2         (print (.upper "aaa"))
-          3  ->     (breakpoint)
-          4         (print (.upper "bbb")))
-        (Pdb)''').strip()
-    print('Got:     ', repr(got))
-    print('Expect:  ', repr(expect))
-    assert expect in got
+
+    arrow_line = 3 if PY3_13 else 4
+      # Bizarrely, Python 3.12 and earlier will point the arrow to the
+      # line after the breakpoint rather than the line with the
+      # breakpoint, even in pure Python.
+    def arrow(i):
+        return '->' if i == arrow_line else ''
+    def clean(x):
+        return re.sub(r'\s+', ' ', x).strip()
+
+    assert (
+        clean(f'''
+            (Pdb) 1         (defn f []
+              2               (print (.upper "aaa"))
+              3  {arrow(3)}   (breakpoint)
+              4  {arrow(4)}   (print (.upper "bbb")))
+            (Pdb)''')
+        in clean(o))
 
 
 def test_hystartup():