The Hy Manual

PyPI:https://pypi.python.org/pypi/hy Source:https://github.com/hylang/hy List:hylang-discuss IRC:irc://chat.freenode.net/hy Stack Overflow:The [hy] tag

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 stable 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.

• Why Hy?
  • Hy versus Python
  • Hy versus other Lisps
• Tutorial
  • Lisp-stick on a Python
  • Literals
  • Basic operations
  • Functions, classes, and modules
  • Macros
  • Next steps
• Hy Style Guide
  • Layout & Indentation
    • The Three Laws
    • Limits
    • Whitespace
    • Alignment
    • Hold it Open
    • Snuggle
    • Grouping
    • Special Arguments
    • Removing Whitespace
    • Close Bracket, Close Line
    • Comments
  • Coding Style
    • Pythonic Names
    • Threading Macros
    • Method Calls
    • Use More Arguments
    • Imports
    • Underscores
  • Thanks
• Documentation Index
  • Command Line Interface
    • hy
    • hyc
    • hy2py
  • Hy <-> Python interop
    • Using Python from Hy
    • Using Hy from Python
  • Syntax
    • identifiers
    • numeric literals
    • string literals
    • format strings
    • keywords
    • symbols
    • discard prefix
  • Built-Ins
    • ^
    • .
    • ->
    • ->>
    • and
    • as->
    • assert
    • assoc
    • await
    • break
    • comment
    • cond
    • continue
    • do
    • doc / #doc
    • dfor
    • setv
    • setx
    • defclass
    • defn
    • defn/a
    • defmain
    • defmacro
    • defmacro/g!
    • defmacro!
    • deftag
    • del
    • doto
    • eval-and-compile
    • eval-when-compile
    • first
    • for
    • gensym
    • get
    • gfor
    • global
    • if / if* / if-not
    • lif and lif-not
    • import
    • fn
    • fn/a
    • last
    • lfor
    • nonlocal
    • not
    • or
    • of
    • py
    • pys
    • quasiquote
    • quote
    • require
    • rest
    • return
    • sfor
    • cut
    • raise
    • try
    • unless
    • unpack-iterable, unpack-mapping
    • unquote
    • unquote-splice
    • when
    • while
    • with
    • with/a
    • with-decorator
    • with-gensyms
    • xor
    • yield
    • yield-from
  • Hy Core
    • Core Functions
    • Sequence Functions
    • Included itertools
  • Model Patterns
    • A motivating example
    • Usage
  • Internal Hy Documentation
    • Hy Models
    • Hy Internal Theory
    • Hy Macros
    • Hy Compiler Built-Ins
• Extra Modules Index
  • Anaphoric Macros
    • ap-if
    • ap-each
    • ap-each-while
    • ap-map
    • ap-map-when
    • ap-filter
    • ap-reject
    • ap-dotimes
    • ap-first
    • ap-last
    • ap-reduce
    • #%
  • Reserved Names
    • names
• Contributor Modules Index
  • loop/recur
    • Macros
  • Profile
    • Macros
  • Lazy sequences
    • seq
    • defseq
    • end-sequence
  • walk
    • Functions
    • Macros
  • Hy representations
    • hy-repr
    • hy-repr-register
• Hacking on Hy
  • Join our Hyve!
  • Hack!
  • Test!
  • Document!
  • Contributor Guidelines
    • Issues
    • Pull requests
  • Contributor Code of Conduct
  • Core Team