v0.15

Author: gpoore

NEWS.rst

@@ -11,77 +11,52 @@
 
 :Author: Geoffrey Poore
 
-:Version: 0.14
+:Version: 0.15
 
 :License:  LPPL_ (LaTeX code) and `BSD 3-Clause`_ (Python code)
 
 .. _LPPL: http://www.latex-project.org/lppl.txt
 
 .. _`BSD 3-Clause`: http://www.opensource.org/licenses/BSD-3-Clause
 
-   
+
+
 Overview
 ========
 
-PythonTeX provides fast, user-friendly access to Python from within LaTeX.  It allows Python code entered within a LaTeX document to be executed, and the results to be included within the original document.  It also provides syntax highlighting for code within LaTeX documents via the Pygments syntax highlighter.
+PythonTeX provides fast, user-friendly access to Python from within LaTeX.  It
+allows Python code entered within a LaTeX document to be executed, and the
+results to be included within the original document.  It also provides syntax
+highlighting for code within LaTeX documents via the Pygments syntax
+highlighter.
 
-PythonTeX also provides support for Ruby, Julia, and Octave.  Support for additional languages is coming soon.
+PythonTeX also provides support for Ruby, Julia, Octave, Sage, Bash, and Rust.
+Support for additional languages is coming soon.
 
-See ``pythontex.pdf`` for detailed installation instructions, or use the installation script for TeX Live and MiKTeX.  See ``pythontex_quickstart.pdf`` to get started, and ``pythontex_gallery.pdf`` for examples of what is possible with PythonTeX.
+See ``pythontex_quickstart.pdf`` to get started, and ``pythontex_gallery.pdf``
+for examples of what is possible with PythonTeX.  PythonTeX is included in
+TeX Live and MiKTeX and may be installed via the package manager.  See
+``pythontex.pdf`` for detailed installation instructions if you want to
+install the current development version, or use the installation script for
+TeX Live and MiKTeX.
+
+The ``depythontex`` utility creates a copy of a PythonTeX document in which
+all Python code has been replaced by its output.  This plain LaTeX document is
+more suitable for journal submission, sharing, or conversion to other document
+formats.  See ``pythontex_gallery.html`` and the accompanying conversion
+script for an example of a PythonTeX document that was converted to HTML via
+``depythontex`` and `Pandoc <http://johnmacfarlane.net/pandoc/>`_.
 
-The ``depythontex`` utility creates a copy of a PythonTeX document in which all Python code has been replaced by its output.  This plain LaTeX document is more suitable for journal submission, sharing, or conversion to other document formats.  See ``pythontex_gallery.html`` and the accompanying conversion script for an example of a PythonTeX document that was converted to HTML via ``depythontex`` and `Pandoc <http://johnmacfarlane.net/pandoc/>`_.
 
 
 Citing PythonTeX
 ================
 
-If you use PythonTeX in your writing and research, please consider citing it in any resulting publications.  The best and most recent paper is in `Computational Science & Discovery <http://stacks.iop.org/1749-4699/8/i=1/a=014010>`_ (doi:10.1088/1749-4699/8/1/014010). You may also cite the paper in the `2013 SciPy proceedings <http://conference.scipy.org/proceedings/scipy2013/poore.html>`_.
-
-
-Latest release
-==============
-
-(Full release history is available `here <https://github.com/gpoore/pythontex/blob/master/NEWS.rst>`_.)
-
-v0.14 (2014/07/17)
-------------------
-
-New features
-~~~~~~~~~~~~
-
-*  All commands for working with code inline are now robust, via 
-   ``etoolbox``'s ``\newrobustcmd``.  Among other things, this allows 
-   commands like ``\py`` to work in standard captions that have not been 
-   redefined to avoid protection issues.
-*  Upgraded ``syncpdb`` to v0.2, which provides better list formatting.
-
-Backward-incompatible changes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-*  The default working directory is now the main document directory instead 
-   of the output directory.  Using the output directory was a common source 
-   of confusion for new users and was incompatible with plans for future 
-   development.  Old documents in which the working directory was not 
-   specified will continue to use the output directory, but PythonTeX will 
-   print an upgrade message; new documents will use the new setting.  The 
-   output directory may be selected as the working directory manually, or 
-   with the shorthand 
-   "``\setpythontexworkingdir{<outputdir>}``".
-
-*  Standardized version numbering by removing the "v" prefix from the stored 
-   version numbers in Python variables and LaTeX macros.  Standardized the 
-   PythonTeX scripts by renaming ``version`` to ``__version__``.
-
-
-Objectives for future releases
-==============================
-
-* Improve support for macro programming with PythonTeX.  Add ``depythontex`` support for user macros.
-* Improve system for adding other languages.
-* Improve ``stderr`` synchronization.  Simplify support for multiple languages.
-* Add finer-grained control.  Work toward ``rerun`` control of execution at the session level, and control of whether ``stdout`` and ``strerr`` are displayed at the command/environment level.
-* Refactor to separate the code-management core from LaTeX-related features, so that the core can be used with other document formats (for example, markdown) in a manner similar to Sweave.
-
+If you use PythonTeX in your writing and research, please consider citing it
+in any resulting publications.  The best and most recent paper is in
+`Computational Science & Discovery <http://stacks.iop.org/1749-4699/8/i=1/a=014010>`_ (doi:10.1088/1749-4699/8/1/014010).
+You may also cite the paper in the
+`2013 SciPy proceedings <http://conference.scipy.org/proceedings/scipy2013/poore.html>`_.
 
 
 

README.rst

@@ -3,28 +3,28 @@
 ===================================================================
 
 :Author:  Geoffrey Poore
-:Version:  0.14 (2014/07/17)
+:Version:  0.15 (2016/07/21)
 :License:  LPPL v1.3 or later (LaTeX code) and BSD 3-Clause (Python code)
 :Development:  https://github.com/gpoore/pythontex
 :Requirements:  Python 2.7 or 3.2+; Pygments
 
 
-The PythonTeX package allows you to enter Python code within a LaTeX 
+The PythonTeX package allows you to enter Python code within a LaTeX
 document, execute the code, and access its output in the original document.
-It also supports the Ruby, Julia, and Octave languages.
+It also supports the Ruby, Julia, Octave, Sage, Bash, and Rust languages.
 
 PythonTeX provides fast, user-friendly access to Python from within LaTeX.
-Python code is only executed when it has been modified, or when it meets 
+Python code is only executed when it has been modified, or when it meets
 user-specified criteria.  Code may be divided into user-defined sessions,
-which automatically run in parallel.  Errors and warnings are synchronized 
-with the LaTeX document, so that they refer to the document's line numbers.  
-External dependencies can be tracked, so that code is re-executed when the 
-data it depends on is modified.  PythonTeX also provides syntax highlighting 
+which automatically run in parallel.  Errors and warnings are synchronized
+with the LaTeX document, so that they refer to the document's line numbers.
+External dependencies can be tracked, so that code is re-executed when the
+data it depends on is modified.  PythonTeX also provides syntax highlighting
 for code in LaTeX documents via the Pygments syntax highlighter.
 
 PythonTeX includes a "depythontex" utility that creates a copy of a document
 in which all Python code has been replaced by its output.  This can be
-convenient for journal submissions, sharing documents, and converting to 
+convenient for journal submissions, sharing documents, and converting to
 other formats.
 
 Consult pythontex_quickstart.pdf and pythontex_gallery.pdf to get
@@ -36,10 +36,10 @@ Compiling a PythonTeX document involves three steps:
 2. Run pythontex.py (all code is executed)
 3. Run latex again (Python output is inputted)
 
-See the main documentation in pythontex.pdf for detailed installation 
+See the main documentation in pythontex.pdf for detailed installation
 instructions.  An installation script is provided for TeX Live and MiKTeX.
-Files should be installed in the directories indicated below.  In summary, 
-all files must be installed, and symlinks or launching wrappers should be 
+Files should be installed in the directories indicated below.  In summary,
+all files must be installed, and symlinks or launching wrappers should be
 created for pythontex.py and depythontex.py.
 
 * /doc/latex/pythontex/

pythontex/README

@@ -86,7 +86,7 @@
 
 # Script parameters
 # Version
-__version__ = '0.15dev'
+__version__ = '0.15'
 
 
 # Functions and parameters for customizing the script output

pythontex/depythontex2.py

@@ -86,7 +86,7 @@
 
 # Script parameters
 # Version
-__version__ = '0.15dev'
+__version__ = '0.15'
 
 
 # Functions and parameters for customizing the script output

pythontex/depythontex3.py

@@ -26,7 +26,7 @@
 %<package>\NeedsTeXFormat{LaTeX2e}[1999/12/01]
 %<package>\ProvidesPackage{pythontex}
 %<*package>
-    [2016/07/20 v0.15dev execute and typeset Python code and other languages]
+    [2016/07/21 v0.15 execute and typeset Python code and other languages]
 %</package>
 %
 %<*driver>
@@ -134,7 +134,7 @@
 %</driver>
 % \fi
 %
-% \CheckSum{3212}
+% \CheckSum{3174}
 %
 % \CharacterTable
 %  {Upper-case    \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
@@ -153,20 +153,25 @@
 %   Right brace   \}     Tilde         \~}
 %
 %
-% \begin{changelog}{v0.15}{2016/07/??}
+% \begin{changelog}{v0.15}{2016/07/21}
 % \textbf{New features}
 % \begin{itemize}
 % \item The \texttt{fvextra} package is now required.  This provides line breaking with fine-grained control over break locations, the ability to highlight specific lines or ranges of lines, improved handling of tabs, and several additional features.
 % \item Added \texttt{sub} commands and environments (\texttt{\string\pys}, \texttt{pysub}, ...).  These commands and environments perform string interpolation on text.  Fields delimited by \texttt{!\{...\}} are replaced by the result of evaluating and then printing their content.  This works for all families of commands and environments, not just Python.  See the documentation for details about field delimiters and escaping.
-% \item Added \texttt{rust} and \texttt{rs} families of commands and environments.  These provide complete support for Rust, except that \texttt{rstex.formatter()}, \texttt{rstex.before()}, and \texttt{rstex.after()} will likely need additional refinement (\#90).
+% \item Added \texttt{rust} and \texttt{rs} families of commands and environments.  These provide essentially complete support for Rust, except that \texttt{rstex.formatter()}, \texttt{rstex.before()}, and \texttt{rstex.after()} will likely need additional refinement (\#90).
 % \item Added the \texttt{sage} family of commands and environments, which provide support for Sage (\#63).
 % \item Added \texttt{bash} family of commands and environments.  This provides basic support for bash (no utilities class or equivalent).  Bash works with Windows if it is installed.
 % \item Improved \texttt{console} compatibility under Linux with Python 3 (\#70).
 % \item Counters for default sessions are now created automatically.  This prevents counter errors under some circumstances when working with \texttt{\string\includeonly}.
+% \item Commands like \texttt{\string\py} can now output verbatim content under LuaTeX.
+% \end{itemize}
+% \textbf{Bugfixes}
+% \begin{itemize}
 % \item Fixed a bug that could cause an endless loop when a \texttt{code} command or environment printed a \texttt{code} command or environment of the same family with \texttt{autoprint=true}.
 % \end{itemize}
 % \end{changelog}
 %
+%
 % \begin{changelog}{v0.14}{2014/07/17}
 % \textbf{New features}
 % \begin{itemize}
@@ -833,7 +838,7 @@
 %
 % Assignment is \textbf{not} allowed using |\py|.  For example, |\py{a=1}| is \textbf{not} valid.  This is because assignment cannot be converted to a string.\footnote{It would be simple to allow any code within |\textbackslash py|, including assignment, by using a |try/except| statement.  In this way, the functionality of |\textbackslash py| and |\textbackslash pyc| could be merged.  While that would be simpler to use, it also has serious drawbacks.  If |\textbackslash py| is not exclusively used to typeset string representations of \meta{code}, then it is no longer possible on the \LaTeX\ side to determine whether a command should return a string.  Thus, it is harder to determine, from within a \TeX\ editor, whether |pythontex.py| needs to be run; warnings for missing Python content could not be issued, because the system wouldn't know (on the \LaTeX\ side) whether content was indeed missing.}
 %
-% The text returned by Python must be valid \LaTeX\ code.  Verbatim and other special content is allowed under the pdfTeX and XeTeX engines (a known bug prevents it from working with LuaTeX).  The primary reasons for using |\py| rather than |print| are (1) |\py| is more compact and (2) |print| requires an external file to be created for every command or environment in which it is used, while |\py| and equivalents for other families share a single external file.  Thus, use of |\py| minimizes the creation of external files, which is a key design goal for \pytex.\footnote{For |\textbackslash py|, the text returned by Python is stored in macros and thus must be valid \LaTeX\ code, because \LaTeX\ interprets the returned content.  The use of macros for storing returned content means that an external file need not be created for each use of |\textbackslash py|.  Rather, all macros created by |\textbackslash py| and equivalent commands from other families are stored in a single file that is inputted.  Note that even though the content is stored in macros, verbatim content is allowed, through the use of special macro definitions combined with \texttt{\string\scantokens}.}  The main reason for using |print| rather than |\py| is if you need to include a very large amount of material; |print|'s use of external files won't use up \TeX's memory, and may give noticeably better performance once the material is sufficiently long.
+% The text returned by Python must be valid \LaTeX\ code.  Verbatim and other special content is allowed.  The primary reasons for using |\py| rather than |print| are (1) |\py| is more compact and (2) |print| requires an external file to be created for every command or environment in which it is used, while |\py| and equivalents for other families share a single external file.  Thus, use of |\py| minimizes the creation of external files, which is a key design goal for \pytex.\footnote{For |\textbackslash py|, the text returned by Python is stored in macros and thus must be valid \LaTeX\ code, because \LaTeX\ interprets the returned content.  The use of macros for storing returned content means that an external file need not be created for each use of |\textbackslash py|.  Rather, all macros created by |\textbackslash py| and equivalent commands from other families are stored in a single file that is inputted.  Note that even though the content is stored in macros, verbatim content is allowed, through the use of special macro definitions combined with \texttt{\string\scantokens}.}  The main reason for using |print| rather than |\py| is if you need to include a very large amount of material; |print|'s use of external files won't use up \TeX's memory, and may give noticeably better performance once the material is sufficiently long.
 %
 % \DescribeMacro{\pyc\oarg{session}\meta{opening~delim}\meta{code}\meta{closing~delim}}
 %
@@ -1790,7 +1795,7 @@
 % We store the name of the package in a macro for later use in warnings and error messages.
 %    \begin{macrocode}
 \newcommand{\pytx@packagename}{PythonTeX}
-\newcommand{\pytx@packageversion}{0.15dev}
+\newcommand{\pytx@packageversion}{0.15}
 %    \end{macrocode}
 %
 % \subsection{Required packages}
@@ -2238,8 +2243,6 @@
 %
 % This prevents the creation of unnecessary files, but it also has a significant drawback:  only some content can be saved in a standard macro.  In particular, verbatim content using |\verb| and |verbatim| will not work.  So we need a way to save anything in a macro.  The solution is to create a special macro that captures its argument verbatim.  The argument is then tokenized when it is used via |\scantokens|.  All of this requires a certain amount of catcode trickery.
 %
-% While this approach works with the XeTeX and pdfTeX engines, it does not work with the LuaTeX engine, which has a known bug in its implementation of |\scantokens|.\footnote{\url{http://tracker.luatex.org/view.php?id=733}}  So we provide a separate version for Lua\TeX\ that does not support verbatim.  The space after the |#1| is intentional, so that the newline at the beginning of the macro definition is gobbled, and the macro content will start with text rather than leading whitespace.  Two separate tests for LuaTeX are performed:  comparison with an undefined macro |\pytx@undefined|, which will work under most circumstances, and comparison with |\relax|, which serves as a backup in case a test for LuaTeX by another package |\let|'s |\directlua| to |\relax| (for example, an |\expandafter\ifx\csname directlua\endcsname\relax| test).
-%
 %    \begin{macrocode}
 \def\pytx@SVMCR#1{%
     \edef\pytx@tmp{\csname #1\endcsname}%
@@ -2256,22 +2259,6 @@
         !expandafter!scantokens!expandafter{#1!empty}}%
 }%
 !endgroup
-\ifx\directlua\pytx@undefined\else
-\def\pytx@SVMCR#1 {%
-    \edef\pytx@tmp{\csname #1\endcsname}%
-    \pytx@SVMCR@i}
-\long\def\pytx@SVMCR@i#1\endpytx@SVMCR{%
-    \expandafter\gdef\pytx@tmp{#1}%
-}
-\fi
-\ifx\directlua\relax\else
-\def\pytx@SVMCR#1 {%
-    \edef\pytx@tmp{\csname #1\endcsname}%
-    \pytx@SVMCR@i}
-\long\def\pytx@SVMCR@i#1\endpytx@SVMCR{%
-    \expandafter\gdef\pytx@tmp{#1}%
-}
-\fi
 %    \end{macrocode}\end{macro}
 %
 % \begin{macro}{pytx@Verbatim}

pythontex/pythontex.dtx

@@ -1,4 +1,4 @@
-%% Copyright (C) 2012-2014 by Geoffrey M. Poore <[email protected]>
+%% Copyright (C) 2012-2016 by Geoffrey M. Poore <[email protected]>
 %% --------------------------------------------------------------------------
 %% This work may be distributed and/or modified under the
 %% conditions of the LaTeX Project Public License, either version 1.3
@@ -25,7 +25,7 @@
 
 This is a generated file.
 
-Copyright (C) 2012-2014 by Geoffrey M. Poore <[email protected]>
+Copyright (C) 2012-2016 by Geoffrey M. Poore <[email protected]>
 --------------------------------------------------------------------------
 This work may be distributed and/or modified under the
 conditions of the LaTeX Project Public License, either version 1.3
@@ -45,9 +45,9 @@ version 2005/12/01 or later.
 \Msg{* To finish the installation you have to move the following *}
 \Msg{* file into a directory searched by TeX:                    *}
 \Msg{*                                                           *}
-\Msg{*     pythontex.sty                                          *}
+\Msg{*     pythontex.sty                                         *}
 \Msg{*                                                           *}
-\Msg{* To produce the documentation run the file pythontex.dtx    *}
+\Msg{* To produce the documentation run the file pythontex.dtx   *}
 \Msg{* through LaTeX.                                            *}
 \Msg{*                                                           *}
 \Msg{* Happy TeXing!                                             *}