[![Gitter](https://badges.gitter.im/hissp-lang/community.svg)](https://gitter.im/hissp-lang/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) [![Documentation Status](https://readthedocs.org/projects/hissp/badge/?version=latest)](https://hissp.readthedocs.io/en/latest/?badge=latest) [![codecov](https://codecov.io/gh/gilch/hissp/branch/master/graph/badge.svg)](https://codecov.io/gh/gilch/hissp) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) # ![Hissp](https://raw.githubusercontent.com/gilch/hissp/master/docs/hissp.svg) It's Python with a *Lissp*. Hissp is a modular Lisp implementation that compiles to a functional subset of Python—Syntactic macro metaprogramming with full access to the Python ecosystem! [//]: # (RELEASE: refresh toc) **Table of Contents** - [Installation](#installation) - [Examples!](#examples) - [Quick Start: Readerless Mode](#quick-start-readerless-mode) - [Special Forms](#special-forms) - [Macros](#macros) - [The Lissp Reader](#the-lissp-reader) - [A Small Lissp Application](#a-small-lissp-application) - [Alternate Readers](#alternate-readers) - [Hebigo](#hebigo) - [Garden of EDN](#garden-of-edn) - [Features and Design](#features-and-design) - [Radical Extensibility](#radical-extensibility) - [Minimal implementation](#minimal-implementation) - [Interoperability](#interoperability) - [Useful error messages](#useful-error-messages) - [Syntax compatible with Emacs' `lisp-mode` and Parlinter](#syntax-compatible-with-emacs-lisp-mode-and-parlinter) - [Standalone output](#standalone-output) - [Reproducible builds](#reproducible-builds) - [REPL-driven development](#repl-driven-development) - [Same-module macro helpers](#same-module-macro-helpers) - [Modularity](#modularity) - [Thorough documentation](#thorough-documentation) ## Installation A Hissp install requires Python 3.10+. (The compiled Python output it generates may work on older versions.) Install the latest PyPI release with ``` python -m pip install --upgrade hissp ``` Or install the bleeding-edge version directly from GitHub with ``` python -m pip install --upgrade git+https://github.com/gilch/hissp ``` Confirm install with ``` python -m hissp --help lissp -c "__hello__." ``` ## Examples! ### Quick Start: Readerless Mode Hissp is a *metaprogramming* intermediate language composed of simple Python data structures, easily generated programmatically, ```python >>> hissp_code = ( ... ('lambda',('name',) ... ,('print',('quote','Hello'),'name',),) ... ) ``` which are compiled to Python code, ```python >>> from hissp import readerless >>> python_code = readerless(hissp_code) >>> print(python_code) (lambda name: print( 'Hello', name) ) ``` and evaluated by Python. ```python >>> greeter = eval(python_code) >>> greeter('World') Hello World >>> greeter('Bob') Hello Bob ``` To a first approximation, tuples represent calls and strings represent Python code in Hissp. (Take everything else literally.) #### Special Forms Like Python, argument expressions are evaluated before being passed to the function, however, the quote and lambda forms are special cases in the compiler which are exceptions to this rule. Strings also have a few special cases: * control words, which start with `:` (and may have various special interpretations in certain contexts); * method calls, which start with `.`, and must be the first element in a tuple representing a call; * and module handles, which end with `.` (and do imports). ```python >>> adv_hissp_code = ( ... ('lambda' # Anonymous function special form. ... # Parameters. ... ,(':' # Control word: remaining parameters are paired with a target. ... ,'name' # Target: Raw Python: Parameter identifier. ... # Default value for name. ... ,('quote' # Quote special form: string, not identifier. ... ,'world'),) ... # Body. ... ,('print' # Function call form, using the identifier for the builtin. ... ,('quote','Hello,'),) ... ,('print' ... ,':' # Control word: Remaining arguments are paired with a target. ... ,':*' # Target: Control word for unpacking. ... ,('.upper','name',) # Method calls start with a dot. ... ,'sep' # Target: Keyword argument. ... ,':' # Control words compile to strings, not raw Python. ... ,'file' # Target: Keyword argument. ... # Module handles like `sys.` end in a dot. ... ,'sys..stdout',),) # print already defaults to stdout though. ... ) ... >>> print(readerless(adv_hissp_code)) (lambda name='world': (print( 'Hello,'), print( *name.upper(), sep=':', file=__import__('sys').stdout)) [-1] ) >>> greetier = eval(readerless(adv_hissp_code)) >>> greetier() Hello, W:O:R:L:D >>> greetier('alice') Hello, A:L:I:C:E ``` #### Macros The ability to make lambdas and call out to arbitrary Python helper functions entails that Hissp can do anything Python can. For example, control flow via higher-order functions. ```python >>> any(map(lambda s: print(s), "abc")) # HOF loop. a b c False >>> def branch(condition, consequent, alternate): # Conditional HOF. ... return (consequent if condition else alternate)() # Pick one to call. ... >>> branch(1, lambda: print('yes'), lambda: print('no')) # Now just a function call. yes >>> branch(0, lambda: print('yes'), lambda: print('no')) no ``` This approach works fine in Hissp, but we can express that more succinctly via metaprogramming. Unlike functions, the special forms don't (always) evaluate their arguments first. Macros can rewrite forms in terms of these, extending that ability to custom tuple forms. ```python >>> class _macro_: # This name is magic in Hissp. ... def thunk(*body): # No self. _macro_ is just used as a namespace. ... # Python code for writing Hissp code. Macros are metaprograms. ... return ('lambda',(),*body,) # Delayed evaluation. ... def if_else(condition, consequent, alternate): ... # Delegates both to a helper function and another macro. ... return ('branch',condition,('thunk',consequent,),('thunk',alternate,),) ... >>> expansion = readerless( ... ('if_else','0==1' # Macro form, not a run-time call. ... ,('print',('quote','yes',),) # Side effect not evaluated! ... ,('print',('quote','no',),),), ... ) # It finds _macro_ in the calling frame's globals. >>> print(expansion) # if_else branch( 0==1, # thunk (lambda : print( 'yes') ), # thunk (lambda : print( 'no') )) >>> eval(expansion) no ``` A number of useful macros come bundled with Hissp. ### The Lissp Reader The Hissp data-structure language can be written directly in Python using the "readerless mode" demonstrated above, or it can be read in from a lightweight textual language called *Lissp* that represents the Hissp a little more neatly. ```python >>> lissp_code = """ ... (lambda (name) ... (print 'Hello name)) ... """ ``` As you can see, this results in exactly the same Hissp code as our earlier example. ```python >>> from hissp.reader import Lissp >>> next(Lissp().reads(lissp_code)) ('lambda', ('name',), ('print', ('quote', 'Hello'), 'name')) >>> _ == hissp_code True ``` Hissp comes with a basic REPL (read-eval-print loop, or interactive command-line interface) which compiles Hissp (read from Lissp) to Python and passes that to the Python REPL for execution. Lissp can also be read from ``.lissp`` files, which compile to Python modules. #### A Small Lissp Application This is a Lissp web app for converting between Celsius and Fahrenheit, which demonstrates a number of language features. Run as the main script or enter it into the Lissp REPL. Requires [Bottle.](https://bottlepy.org/docs/dev/) ```Racket hissp..prelude#: (define enjoin en#X#(.join "" (map str X))) (defun tag (tag : :* contents) (enjoin "<"tag">"(enjoin : :* contents)"")) (defmacro script (: :* forms) `',(tag "script type='text/python'" "\n" (.join "\n" (map hissp.compiler..readerless forms)))) ((bottle..route "/") ; https://bottlepy.org O#(enjoin (let (s (tag "script src='https://cdn.jsdelivr.net/npm/brython@3/brython{}.js'")) (enjoin (.format s ".min") (.format s "_stdlib"))) (tag "body onload='brython()'" ; Browser Python: https://brython.info (script (define getE X#(.getElementById browser..document X)) (define getf@v X#(float @##'value (getE X))) (define set@v XY#(setattr (getE Y) 'value X)) (attach browser..window : Celsius O#(-> (getf@v 'Celsius) (X#|X*1.8+32|) (set@v 'Fahrenheit)) Fahrenheit O#(-> (getf@v 'Fahrenheit) (X#|(X-32)/1.8|) (set@v 'Celsius)))) (let (row (enjoin (tag "input id='{0}' onkeyup='{0}()'") (tag "label for='{0}'" "°{1}"))) (enjoin (.format row "Fahrenheit" "F")"
"(.format row "Celsius" "C")))))) (bottle..run : host "localhost" port 8080 debug True) ``` This example uses *munged names*. Munging expands the set of characters allowed in identifier names. For example, the `getf@v` is an alias for `getfQzAT_v`. It also uses *tags*, which are metaprograms run by the reader. Normal tags end in one or more `#` characters indicating arity, but there are also built in unary tagging tokens (including `'` and `,`) which do not. For example, the `O#` (`_macro_.OQzHASH_`) rewrites its argument to a lambda with zero parameters. Consult the [Hissp documentation](https://hissp.readthedocs.io/) for an explanation of each form. ### Alternate Readers Hissp is modular, and the reader included for Lissp is not the only one. #### Hebigo Here's a native unit test class from the separate [Hebigo](https://github.com/gilch/hebigo) prototype, a Hissp reader and macro suite implementing a language designed to resemble Python: ```python class: TestOr: TestCase def: .test_null: self self.assertEqual: () or: def: .test_one: self x :@ given: st.from_type: type self.assertIs: x or: x def: .test_two: self x y :@ given: st.from_type: type st.from_type: type self.assertIs: (x or y) or: x y def: .test_shortcut: self or: 1 (0/0) or: 0 1 (0/0) or: 1 (0/0) (0/0) def: .test_three: self x y z :@ given: st.from_type: type st.from_type: type st.from_type: type self.assertIs: (x or y or z) or: x y z ``` The same Hissp macros work in readerless mode, Lissp, and Hebigo, and can be written in any of these. Given Hebigo's macros, the class above could be written in the equivalent way in Lissp: ```Racket (class_ (TestOr TestCase) (def_ (.test_null self) (self.assertEqual () (or_))) (def_ (.test_one self x) :@ (given (st.from_type type)) (self.assertIs x (or_ x))) (def_ (.test_two self x y) :@ (given (st.from_type type) (st.from_type type)) (self.assertIs |x or y| (or_ x y))) (def_ (.test_shortcut self) (or_ 1 |0/0|) (or_ 0 1 |0/0|) (or_ 1 |0/0| |0/0|)) (def_ (.test_three self x y z) :@ (given (st.from_type type) (st.from_type type) (st.from_type type)) (self.assertIs |x or y or z| (or_ x y z)))) ``` Hebigo looks very different from Lissp, but they are both Hissp! If you quote this Hebigo code and print it out, you get Hissp code, just like you would with Lissp. In Hebigo's REPL, that looks like ``` In [1]: pprint..pp:quote:class: TestOr: TestCase ...: def: .test_null: self ...: self.assertEqual: () or: ...: def: .test_one: self x ...: :@ given: st.from_type: type ...: self.assertIs: x or: x ...: def: .test_two: self x y ...: :@ given: ...: st.from_type: type ...: st.from_type: type ...: self.assertIs: (x or y) or: x y ...: def: .test_shortcut: self ...: or: 1 (0/0) ...: or: 0 1 (0/0) ...: or: 1 (0/0) (0/0) ...: def: .test_three: self x y z ...: :@ given: ...: st.from_type: type ...: st.from_type: type ...: st.from_type: type ...: self.assertIs: (x or y or z) or: x y z ...: ('hebi.basic.._macro_.class_', ('TestOr', 'TestCase'), ('hebi.basic.._macro_.def_', ('.test_null', 'self'), ('self.assertEqual', '()', ('hebi.basic.._macro_.or_',))), ('hebi.basic.._macro_.def_', ('.test_one', 'self', 'x'), ':@', ('given', ('st.from_type', 'type')), ('self.assertIs', 'x', ('hebi.basic.._macro_.or_', 'x'))), ('hebi.basic.._macro_.def_', ('.test_two', 'self', 'x', 'y'), ':@', ('given', ('st.from_type', 'type'), ('st.from_type', 'type')), ('self.assertIs', '((x or y))', ('hebi.basic.._macro_.or_', 'x', 'y'))), ('hebi.basic.._macro_.def_', ('.test_shortcut', 'self'), ('hebi.basic.._macro_.or_', 1, '((0/0))'), ('hebi.basic.._macro_.or_', 0, 1, '((0/0))'), ('hebi.basic.._macro_.or_', 1, '((0/0))', '((0/0))')), ('hebi.basic.._macro_.def_', ('.test_three', 'self', 'x', 'y', 'z'), ':@', ('given', ('st.from_type', 'type'), ('st.from_type', 'type'), ('st.from_type', 'type')), ('self.assertIs', '((x or y or z))', ('hebi.basic.._macro_.or_', 'x', 'y', 'z')))) ``` #### Garden of EDN Extensible Data Notation (EDN) is a subset of Clojure used for data exchange, as JSON is to JavaScript, only more extensible. Any Clojure editor should be able to handle EDN. The separate [Garden of EDN](https://github.com/gilch/garden-of-edn) prototype contains a variety of EDN readers in Python, and two of them read EDN into Hissp. Here's little snake game in PandoraHissp, one of the EDN Hissp dialects, which includes Clojure-like persistent data structures. ```EDN 0 ; from garden_of_edn import _this_file_as_main_; """#" #hissp/prelude . (define TICK 100) (define WIDTH 40) (define HEIGHT 20) (define SNAKE (pyrsistent/dq (complex 3 2) (complex 2 2))) (define BINDS {"w" [(complex 0 -1)] "a" [(complex -1 0)] "s" [(complex 0 +1)] "d" [(complex +1 0)]}) (define arrow (collections/deque)) (define root (doto (tkinter/Tk) (.resizable 0 0) (.bind "" #X(.extendleft arrow (.get BINDS X.char ()))))) (define label (doto (tkinter/Label) .pack (.configure . font "TkFixedFont" justify "left" height (add 1 HEIGHT) width WIDTH))) (defun wall? z (ors (contains #{WIDTH -1} z.real) (contains #{HEIGHT -1} z.imag))) (defun food! . (complex (random/randint 0 (sub WIDTH 1)) (random/randint 0 (sub HEIGHT 1)))) (defun frame (state) (-<>> (product (range HEIGHT) (range WIDTH)) (starmap #XY(complex Y X)) (map #X(concat (cond (contains state.snake X) "O" (eq X state.food) "@" :else " ") (if-else (eq 0 X.real) "\n" ""))) (.join ""))) (defun move (state new-food arrow) (let (direction (if-else (ands arrow (ne arrow (neg state.direction))) arrow state.direction)) (let (head (add (getitem state.snake 0) direction)) (-> state (.update (if-else (eq head state.food) {"score" (add 1 state.score) "food" new-food} {"snake" (.pop state.snake)}) {"direction" direction}) (.transform ["snake"] #X(.appendleft X head)))))) (defun lost? (state) (let (head (getitem state.snake 0)) (ors (wall? head) (contains (getitem state.snake (slice 1 None)) head)))) (defun update! (state) (-<>> (if-else (lost? state) " GAME OVER!" (prog1 "" (.after root TICK update! (move state (food!) (when arrow (.pop arrow)))))) (.format "Score: {}{}{}" state.score :<> (frame state)) (.configure label . text))) (when (eq __name__ "__main__") (update! {"score" 0, "direction" 1, "snake" SNAKE, "food" (food!)}) (.mainloop root)) ;; """#" ``` The first and last lines make this a valid Python file as well as EDN. ## Features and Design Python is already a really nice language, a lot closer to Lisp than to C or Fortran. It has dynamic types and automatic garbage collection, for example. So why do we need Hissp? If the only programming languages you've tried are those designed to feel familiar to C programmers, you might think they're all the same. I assure you, they are not. ### Radical Extensibility While any Turing-complete language has equivalent theoretical power, they are not equally *expressive*. They can be higher or lower level. You already know this. It's why you don't write assembly language when you can avoid it. It's not that assembly isn't powerful enough to do everything the computer can. Ultimately, the machine only understands machine code. The best programming languages have some kind of expressive superpower. Features that lesser languages lack. Lisp's superpower is *metaprogramming*, and it's the power to copy the others. It's not that Python can't do metaprogramming at all. (Python is Turing complete, after all.) You can already do all of this in Python, and more easily than in many other languages. But it's too difficult (compared to Lisp), so it's done rarely and by specialists. The use of `exec()` is frowned upon. It's easy enough to understand, but hard to get right. Python Abstract Syntax Tree (AST) manipulation is a somewhat more reliable technique, but not for the faint of heart. Python AST is not simple, because Python isn't. Python really is a great language to work with. It has steadily grown in popularity over decades, even without the advantages enjoyed by its competitors, like a corporate sponsor (Java), killer app (Ruby), or captive audience (JavaScript), because it is just that good. Describing it as "executable pseudocode" is not too far off. But it is too complex to be good at metaprogramming. By stripping Python down to a minimal subset, and encoding that subset as simple data structures rather than text (or complicated and error-prone Python AST), Hissp makes metaprogramming as easy as the kind of data manipulation you already do every day. On its own, meta-power doesn't seem that impressive. But what you make with it can be. > A Lisp programmer who notices a common pattern in their code can write a macro to give themselves a source-level > abstraction of that pattern. A Java programmer who notices the same pattern has to convince Sun that this particular > abstraction is worth adding to the language. Then Sun has to publish a JSR and convene an industry-wide "expert group" > to hash everything out. That process--according to Sun--takes an average of 18 months. After that, the compiler writers > all have to go upgrade their compilers to support the new feature. And even once the Java programmer's favorite compiler > supports the new version of Java, they probably still can't use the new feature until they're allowed to break source > compatibility with older versions of Java. So an annoyance that Common Lisp programmers can resolve for themselves > within five minutes plagues Java programmers for years. > — Peter Seibel (2005) *Practical Common Lisp* Actively developed languages keep accumulating features, Python is no execption. Often they're helpful, but sometimes it's a misstep. The more complex a language gets, the more difficult it becomes to master. (With C++ being a particularly egregious case.) Hissp takes the opposite approach: extensibility through simplicity. Major features that would require a new language version in lower languages can be a library in a Lisp. It's how Clojure got Goroutines like Go and logic programming like Prolog, without changing the core language at all. The Lissp reader and Hissp compiler are both extensible with metaprograms. It's not just about getting the best features from other languages, but all the minor powers you can make for yourself along the way. You're not going to campaign for a new Python language feature and wait six months for another release just for something that might be nice to have for you special problem at the moment. But in Hissp, *you can totally have that*. You can program the language itself to fit your problem domain. Once your Python project is "sufficiently complicated", you'll start hacking in new language features just to cope. And it will be hard, because you'll be using a language too low-level for your needs, even if it's a relatively high-level language like Python. Lisp is as high level as a programming language gets, because you can program in anything higher. ### Minimal implementation Hissp serves as a modular component for other projects. The language and its implementation are meant to be small and comprehensible by a single individual. The Hissp compiler should include what it needs to achieve its goals, but no more. Bloat is resisted. A goal of Hissp is to be as small as is reasonably practical, but no smaller. We're not code golfing here; readability still counts. But this project has *limited scope*. Hissp's powerful macro system means that additions to the compiler are rarely needed. Feature creep belongs in external libraries, not in the compiler proper. If you strip out the documentation and blank lines, the entire `hissp` package only has around 1350 lines of source code left over. Hissp compiles to an unpythonic *functional subset* of Python. This subset has a direct and easy-to-understand correspondence to the Hissp code, which makes it straightforward to debug, once you understand Hissp. But it is definitely not meant to be idiomatic Python. That would require a much more complex compiler, because idiomatic Python is not simple. ### Interoperability Why base a Lisp on Python when there are already lots of other Lisps? Python has a rich selection of libraries for a variety of domains and Hissp can mostly use them as easily as the standard library. This gives Hissp a massive advantage over other Lisps with less selection. If you don't care to work with the Python ecosystem, perhaps Hissp is not the Lisp for you. Note that the Hissp compiler is currently written for Python 3.10, and the bundled metaprograms may assume at least that level. (Supporting older versions is not a goal, because that would complicate the compiler. This may limit the available libraries.) But because the compiler's target functional Python subset is so small, the compiled output can usually be made to run on Python 3.5 without too much difficulty. Watch out for positional-only arguments (new to 3.8) and changes to the standard library. Running on versions even older than 3.5 is not recommended, but may likewise be possible if you carefully avoid using newer Python features. Python code can also import and use modules written in Hissp, because they compile to Python. ### Useful error messages One of Python's best features. Any errors that prevent compilation should be easy to find. Hissp errs on the side of verbosity. ### Syntax compatible with Emacs' `lisp-mode` and Parlinter A language is not very usable without tools. Hissp's basic reader syntax (Lissp) should work with Emacs. The alternative EDN readers are compatible with Clojure editors. Hebigo was designed to work with minimal editor support. All it really needs is the ability to cut, paste, and indent/dedent blocks of code. Even [IDLE](https://docs.python.org/3/library/idle.html) would do. ### Standalone output This is part of Hissp's commitment to modularity. One can, of course, write Hissp code that depends on any Python library. But the compiler does not depend on emitting calls out to any special Hissp helper functions to work. You do not need Hissp installed to run the final compiled Python output, only Python itself. Hissp bundles some metaprograms to get you started. Their expansions have no external requirements either. Applications and libraries built on Hissp need not follow this restriction; they're free to add any dependencies usable by Python. ### Reproducible builds A newer Python feature that Lissp respects. Lissp's gensym format is deterministic, yet unlikely to collide even among standalone modules compiled at different times. If you haven't changed anything, your code will compile the same way. One could, of course, write randomized macros, but that's no fault of Lissp's. ### REPL-driven development A Lisp tradition, and Hissp is no exception. Even though it's a compiled language, Hissp has an interactive command-line interface like Python does. The REPL displays the compiled Python and evaluates it. Printed values use the normal Python reprs. (Translating those to back to Lissp is not a goal. Lissp is not the only Hissp reader.) Hissp comes with utilities to write reloadable modules. You can get a subREPL inside any module and refresh changes without restarting your session. Updates to classes made with the bundled macros propagate to existing instances. ### Same-module macro helpers Functions are generally preferable to macros when functions can do the job. They're more reusable and composable. Therefore, it makes sense for macros to delegate to functions where possible. But such a macro should work in the same module as its helper functions. This requires incremental compilation and evaluation of forms in Lissp modules, like the REPL. ### Modularity The Hissp language is made of tuples (and atoms), not text. The S-expression reader included with the project (Lissp) is just a convenient way to write them. It's possible to write Hissp in "readerless mode" by writing these tuples in Python. Hissp's standard library is just Python's. Additional functional libraries (Toolz and Pyrsistent) are recommended for a more Clojure-like experience, but are not required. There are only two special forms: ``quote`` and ``lambda``. Hissp does bundle a metaprogramming suite, but you are not obligated to use them when writing Hissp. And if you do use them (correctly), the compiled output is standalone; it doesn't require an installation of Hissp. It's possible for an external project to provide an alternative reader with different syntax, as long as the output is Hissp code. One example of this is [Hebigo](https://github.com/gilch/hebigo), which has a more Python-like indentation-based syntax. Hissp is not locked into any one Lisp paradigm. It could work with a Clojure-like, Scheme-like, or Common-Lisp-like, etc., reader, function, and macro libraries. Its bundled metaprogramming library is optional, it produces standalone output, and it's modular enough for alternate readers to exist. ### Thorough documentation The API docs have usage examples demonstrating how to use every bundled metaprogram. Every example is tested and working, because these double as part of Hissp's test suite. They're also available via Python's `help()` facility. There are tutorials teaching the language itself, and how to write metaprograms with it. The [Hissp Community Chat](https://gitter.im/hissp-lang/community) is available if you get stuck, or want to talk about anything on the topic of Hissp.

hissp

Quick Overview

Scores

Trust Score

Maintenance

Popularity

Star History

Snapshot Versions

Alternatives

claude-mem

learn-claude-code

gpt-engineer

ruflo

cherry-studio

CowAgent

Community Reviews

README