docs/index.html

<!DOCTYPE html PUBLIC ""
    "">
<html><head><meta charset="UTF-8" /><title>libpython-clj 2.024</title><script async="true" src="https://www.googletagmanager.com/gtag/js?id=G-LN7PG6FJ2D"></script><script>window.dataLayer = window.dataLayer || [];
  function gtag(){dataLayer.push(arguments);}
  gtag('js', new Date());

  gtag('config', 'G-LN7PG6FJ2D');</script><link rel="stylesheet" type="text/css" href="css/default.css" /><link rel="stylesheet" type="text/css" href="highlight/solarized-light.css" /><script type="text/javascript" src="highlight/highlight.min.js"></script><script type="text/javascript" src="js/jquery.min.js"></script><script type="text/javascript" src="js/page_effects.js"></script><script>hljs.initHighlightingOnLoad();</script></head><body><div id="header"><h2>Generated by <a href="https://github.com/weavejester/codox">Codox</a> with <a href="https://github.com/xsc/codox-theme-rdash">RDash UI</a> theme</h2><h1><a href="index.html"><span class="project-title"><span class="project-name">libpython-clj</span> <span class="project-version">2.024</span></span></a></h1></div><div class="sidebar primary"><h3 class="no-link"><span class="inner">Project</span></h3><ul class="index-link"><li class="depth-1 current"><a href="index.html"><div class="inner">Index</div></a></li></ul><h3 class="no-link"><span class="inner">Topics</span></h3><ul><li class="depth-1 "><a href="Usage.html"><div class="inner"><span>LibPython-CLJ Usage</span></div></a></li><li class="depth-1 "><a href="embedded.html"><div class="inner"><span>Embedding Clojure In Python</span></div></a></li><li class="depth-1 "><a href="environments.html"><div class="inner"><span>Python Environments</span></div></a></li><li class="depth-1 "><a href="new-to-clojure.html"><div class="inner"><span>So Many Parenthesis!</span></div></a></li><li class="depth-1 "><a href="scopes-and-gc.html"><div class="inner"><span>Scopes And Garbage Collection</span></div></a></li><li class="depth-1 "><a href="slicing.html"><div class="inner"><span>Slicing And Slices</span></div></a></li></ul><h3 class="no-link"><span class="inner">Namespaces</span></h3><ul><li class="depth-1"><div class="no-link"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>libpython-clj2</span></div></div></li><li class="depth-2 branch"><a href="libpython-clj2.codegen.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>codegen</span></div></a></li><li class="depth-2 branch"><a href="libpython-clj2.embedded.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>embedded</span></div></a></li><li class="depth-2 branch"><a href="libpython-clj2.java-api.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>java-api</span></div></a></li><li class="depth-2"><a href="libpython-clj2.python.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>python</span></div></a></li><li class="depth-3"><a href="libpython-clj2.python.np-array.html"><div class="inner"><span class="tree"><span class="top"></span><span class="bottom"></span></span><span>np-array</span></div></a></li><li class="depth-2"><a href="libpython-clj2.require.html"><div class="inner"><span class="tree" style="top: -52px;"><span class="top" style="height: 61px;"></span><span class="bottom"></span></span><span>require</span></div></a></li></ul></div><div class="namespace-index" id="content"><h1><span class="project-title"><span class="project-name">libpython-clj</span> <span class="project-version">2.024</span></span></h1><div class="doc"><p>Python bindings for Clojure.</p></div><h2>Topics</h2><ul class="topics"><li><a href="Usage.html">LibPython-CLJ Usage</a></li><li><a href="embedded.html">Embedding Clojure In Python</a></li><li><a href="environments.html">Python Environments</a></li><li><a href="new-to-clojure.html">So Many Parenthesis!</a></li><li><a href="scopes-and-gc.html">Scopes And Garbage Collection</a></li><li><a href="slicing.html">Slicing And Slices</a></li></ul><h2>Namespaces</h2><div class="namespace"><h3><a href="libpython-clj2.codegen.html">libpython-clj2.codegen</a></h3><div class="doc"><div class="markdown"><p>Generate a namespace on disk for a python module or instances</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="libpython-clj2.codegen.html#var-write-namespace.21">write-namespace!</a> </li></ul></div></div><div class="namespace"><h3><a href="libpython-clj2.embedded.html">libpython-clj2.embedded</a></h3><div class="doc"><div class="markdown"><p>Tools for embedding clojure into a python host process.
See jbridge.py for python details.  This namespace relies on
the classpath having nrepl and cider-nrepl on it.  For example:</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="libpython-clj2.embedded.html#var-initialize.21">initialize!</a> </li><li> <a href="libpython-clj2.embedded.html#var-start-repl.21">start-repl!</a> </li><li> <a href="libpython-clj2.embedded.html#var-stop-repl.21">stop-repl!</a> </li></ul></div></div><div class="namespace"><h3><a href="libpython-clj2.java-api.html">libpython-clj2.java-api</a></h3><div class="doc"><div class="markdown"><p>A java api is exposed for libpython-clj2.  The methods below are statically callable
without the leading '-'.  Note that returned python objects implement the respective
java interfaces so a python dict will implement java.util.Map, etc.  There is some
startup time as Clojure dynamically compiles the source code but this binding should
have great runtime characteristics in comparison to any other java python engine.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="libpython-clj2.java-api.html#var--arrayToJVM">-arrayToJVM</a> </li><li> <a href="libpython-clj2.java-api.html#var--call">-call</a> </li><li> <a href="libpython-clj2.java-api.html#var--callKw">-callKw</a> </li><li> <a href="libpython-clj2.java-api.html#var--copyData">-copyData</a> </li><li> <a href="libpython-clj2.java-api.html#var--copyToJVM">-copyToJVM</a> </li><li> <a href="libpython-clj2.java-api.html#var--copyToPy">-copyToPy</a> </li><li> <a href="libpython-clj2.java-api.html#var--createArray">-createArray</a> </li><li> <a href="libpython-clj2.java-api.html#var--getAttr">-getAttr</a> </li><li> <a href="libpython-clj2.java-api.html#var--getGlobal">-getGlobal</a> </li><li> <a href="libpython-clj2.java-api.html#var--getItem">-getItem</a> </li><li> <a href="libpython-clj2.java-api.html#var--GILLocker">-GILLocker</a> </li><li> <a href="libpython-clj2.java-api.html#var--hasAttr">-hasAttr</a> </li><li> <a href="libpython-clj2.java-api.html#var--hasItem">-hasItem</a> </li><li> <a href="libpython-clj2.java-api.html#var--importModule">-importModule</a> </li><li> <a href="libpython-clj2.java-api.html#var--initialize">-initialize</a> </li><li> <a href="libpython-clj2.java-api.html#var--initializeEmbedded">-initializeEmbedded</a> </li><li> <a href="libpython-clj2.java-api.html#var--lockGIL">-lockGIL</a> </li><li> <a href="libpython-clj2.java-api.html#var--makeFastcallable">-makeFastcallable</a> </li><li> <a href="libpython-clj2.java-api.html#var--runStringAsFile">-runStringAsFile</a> </li><li> <a href="libpython-clj2.java-api.html#var--runStringAsInput">-runStringAsInput</a> </li><li> <a href="libpython-clj2.java-api.html#var--setAttr">-setAttr</a> </li><li> <a href="libpython-clj2.java-api.html#var--setGlobal">-setGlobal</a> </li><li> <a href="libpython-clj2.java-api.html#var--setItem">-setItem</a> </li><li> <a href="libpython-clj2.java-api.html#var--unlockGIL">-unlockGIL</a> </li></ul></div></div><div class="namespace"><h3><a href="libpython-clj2.python.html">libpython-clj2.python</a></h3><div class="doc"><div class="markdown"><p>Python bindings for Clojure.  This library dynamically finds the installed
python, loads the shared library and allows Clojure users to use Python modules
as if they were Clojure namespaces.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="libpython-clj2.python.html#var-.24a">$a</a> </li><li> <a href="libpython-clj2.python.html#var-.24c">$c</a> </li><li> <a href="libpython-clj2.python.html#var--.3Ejvm">-&gt;jvm</a> </li><li> <a href="libpython-clj2.python.html#var--.3Epy-dict">-&gt;py-dict</a> </li><li> <a href="libpython-clj2.python.html#var--.3Epy-list">-&gt;py-list</a> </li><li> <a href="libpython-clj2.python.html#var--.3Epy-tuple">-&gt;py-tuple</a> </li><li> <a href="libpython-clj2.python.html#var--.3Epython">-&gt;python</a> </li><li> <a href="libpython-clj2.python.html#var-add-module">add-module</a> </li><li> <a href="libpython-clj2.python.html#var-afn">afn</a> </li><li> <a href="libpython-clj2.python.html#var-as-jvm">as-jvm</a> </li><li> <a href="libpython-clj2.python.html#var-as-list">as-list</a> </li><li> <a href="libpython-clj2.python.html#var-as-map">as-map</a> </li><li> <a href="libpython-clj2.python.html#var-as-python">as-python</a> </li><li> <a href="libpython-clj2.python.html#var-call-attr">call-attr</a> </li><li> <a href="libpython-clj2.python.html#var-call-attr-kw">call-attr-kw</a> </li><li> <a href="libpython-clj2.python.html#var-callable.3F">callable?</a> </li><li> <a href="libpython-clj2.python.html#var-cfn">cfn</a> </li><li> <a href="libpython-clj2.python.html#var-create-class">create-class</a> </li><li> <a href="libpython-clj2.python.html#var-def-unpack">def-unpack</a> </li><li> <a href="libpython-clj2.python.html#var-dir">dir</a> </li><li> <a href="libpython-clj2.python.html#var-from-import">from-import</a> </li><li> <a href="libpython-clj2.python.html#var-get-attr">get-attr</a> </li><li> <a href="libpython-clj2.python.html#var-get-item">get-item</a> </li><li> <a href="libpython-clj2.python.html#var-has-attr.3F">has-attr?</a> </li><li> <a href="libpython-clj2.python.html#var-has-item.3F">has-item?</a> </li><li> <a href="libpython-clj2.python.html#var-import-as">import-as</a> </li><li> <a href="libpython-clj2.python.html#var-import-module">import-module</a> </li><li> <a href="libpython-clj2.python.html#var-initialize.21">initialize!</a> </li><li> <a href="libpython-clj2.python.html#var-is-instance.3F">is-instance?</a> </li><li> <a href="libpython-clj2.python.html#var-make-callable">make-callable</a> </li><li> <a href="libpython-clj2.python.html#var-make-fastcallable">make-fastcallable</a> </li><li> <a href="libpython-clj2.python.html#var-make-instance-fn">make-instance-fn</a> </li><li> <a href="libpython-clj2.python.html#var-make-kw-instance-fn">make-kw-instance-fn</a> </li><li> <a href="libpython-clj2.python.html#var-module-dict">module-dict</a> </li><li> <a href="libpython-clj2.python.html#var-path-.3Epy-obj">path-&gt;py-obj</a> </li><li> <a href="libpython-clj2.python.html#var-py*">py*</a> </li><li> <a href="libpython-clj2.python.html#var-py**">py**</a> </li><li> <a href="libpython-clj2.python.html#var-py.">py.</a> </li><li> <a href="libpython-clj2.python.html#var-py.-">py.-</a> </li><li> <a href="libpython-clj2.python.html#var-py..">py..</a> </li><li> <a href="libpython-clj2.python.html#var-python-type">python-type</a> </li><li> <a href="libpython-clj2.python.html#var-run-simple-string">run-simple-string</a> </li><li> <a href="libpython-clj2.python.html#var-set-attr.21">set-attr!</a> </li><li> <a href="libpython-clj2.python.html#var-set-attrs.21">set-attrs!</a> </li><li> <a href="libpython-clj2.python.html#var-set-item.21">set-item!</a> </li><li> <a href="libpython-clj2.python.html#var-set-items.21">set-items!</a> </li><li> <a href="libpython-clj2.python.html#var-stack-resource-context">stack-resource-context</a> </li><li> <a href="libpython-clj2.python.html#var-with">with</a> </li><li> <a href="libpython-clj2.python.html#var-with-gil">with-gil</a> </li><li> <a href="libpython-clj2.python.html#var-with-gil-stack-rc-context">with-gil-stack-rc-context</a> </li><li> <a href="libpython-clj2.python.html#var-with-manual-gil">with-manual-gil</a> </li><li> <a href="libpython-clj2.python.html#var-with-manual-gil-stack-rc-context">with-manual-gil-stack-rc-context</a> </li></ul></div></div><div class="namespace"><h3><a href="libpython-clj2.python.np-array.html">libpython-clj2.python.np-array</a></h3><div class="doc"><div class="markdown"><p>Bindings for deeper intergration of numpy into the tech.v3.datatype system.  This
allows seamless usage of numpy arrays in datatype and tensor functionality such as
enabling the tech.v3.tensor/ensure-tensor call to work with numpy arrays -- using
zero copying when possible.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="libpython-clj2.python.np-array.html#var-datatype-.3Eptr-type-name">datatype-&gt;ptr-type-name</a> </li><li> <a href="libpython-clj2.python.np-array.html#var-descriptor-.3Enumpy">descriptor-&gt;numpy</a> </li><li> <a href="libpython-clj2.python.np-array.html#var-dtype-.3Epy-dtype-map">dtype-&gt;py-dtype-map</a> </li><li> <a href="libpython-clj2.python.np-array.html#var-numpy-.3Edesc">numpy-&gt;desc</a> </li><li> <a href="libpython-clj2.python.np-array.html#var-obj-dtype-.3Edtype">obj-dtype-&gt;dtype</a> </li><li> <a href="libpython-clj2.python.np-array.html#var-py-dtype-.3Edtype-map">py-dtype-&gt;dtype-map</a> </li></ul></div></div><div class="namespace"><h3><a href="libpython-clj2.require.html">libpython-clj2.require</a></h3><div class="doc"><div class="markdown"><p>Namespace implementing requiring python modules as Clojure namespaces.  This works via
scanning the module for metadata and dynamically building the Clojure namespace.</p>
</div></div><div class="index"><p>Public variables and functions:</p><ul><li> <a href="libpython-clj2.require.html#var-import-python">import-python</a> </li><li> <a href="libpython-clj2.require.html#var-require-python">require-python</a> </li></ul></div></div></div></body></html>