如何构建包含 pythontex 或 fancyvrb 环境的宏？

Question 1

也许你可以使用解析's +v-argument-type 让 LaTeX 逐字读取内容。

这壳牌-package 提供命令\ShellEscape作为将命令写入控制台/shell 的一种方式。
您可能可以使用它来pythontex“从 LaTeX-run 内部”进行调用。

如果在我的系统上我将以下代码保存为test.tex

\documentclass{minimal}

\usepackage{shellesc}
\ShellEscape{pythontex \jobname.pytxcode }

\usepackage{amsmath}
\usepackage{xparse}
\usepackage[keeptemps, gobble=auto]{pythontex}

\newcommand\runSomeCodeCatcodeBegingroup{%
  \begingroup
  \catcode`\^^I=12 %
  \catcode`\^^M=12 %
  \newlinechar=\endlinechar
}%
\NewDocumentCommand{\runSomeCode}{}{%
  \runSomeCodeCatcodeBegingroup
  \runSomeCodeInternal
}%
\begingroup
\catcode`\^^M=12\relax%
\NewDocumentCommand{\runSomeCodeInternal}{+v+v}{%
  \endgroup%
  \NewDocumentCommand{\runSomeCodeInternal}{+v+v}{%
     \scantokens{\endgroup#1[##1]^^M##2^^M#2}%
     \ignorespaces%
  }%
}%
\runSomeCodeInternal{\begin{sympycode}}{\end{sympycode}}%

\NewDocumentCommand{\newCodeSnippet}{m}{%
  \runSomeCodeCatcodeBegingroup
  \newCodeSnippetInternal{#1}%
}%

\NewDocumentCommand{\newCodeSnippetInternal}{m+v+v}{%
  \endgroup
  \newcommand*{#1}[1][#2]{\scantokens{\runSomeCode{##1}{#3}}}%
  \ignorespaces
}%

\begin{document}

\newCodeSnippet{\functionExpression}{SessionA}{functionExpression = x**9 + 7*z}

\runSomeCode{SessionA}{x, z = symbols('x z')}
\functionExpression

\runSomeCode{SessionB}{
  x = 2
  z = 3
}
\functionExpression[SessionB]


\begin{equation*}
\sympy[SessionA]{x} = \sympy[SessionB]{x};
\sympy[SessionA]{z} = \sympy[SessionB]{z}
\to \frac{d}{dz} f\left(z\right) = \sympy[SessionA]{functionExpression} = \sympy[SessionB]{functionExpression}
\end{equation*}


\runSomeCode{SessionC}{
  x = 1
  z = 1
}
\functionExpression[SessionC]

\begin{equation*}
\sympy[SessionA]{x} = \sympy[SessionC]{x};
\sympy[SessionA]{z} = \sympy[SessionC]{z}
\to \frac{d}{dz} f\left(z\right)  = \sympy[SessionA]{functionExpression} = \sympy[SessionC]{functionExpression}
\end{equation*}


\end{document}

并通过 shell 命令编译两次

pdflatex -shell-escape test.tex

，然后我得到这个：

Answer

也许你可以使用解析's +v-argument-type 让 LaTeX 逐字读取内容。

这壳牌-package 提供命令\ShellEscape作为将命令写入控制台/shell 的一种方式。
您可能可以使用它来pythontex“从 LaTeX-run 内部”进行调用。

如果在我的系统上我将以下代码保存为test.tex

\documentclass{minimal}

\usepackage{shellesc}
\ShellEscape{pythontex \jobname.pytxcode }

\usepackage{amsmath}
\usepackage{xparse}
\usepackage[keeptemps, gobble=auto]{pythontex}

\newcommand\runSomeCodeCatcodeBegingroup{%
  \begingroup
  \catcode`\^^I=12 %
  \catcode`\^^M=12 %
  \newlinechar=\endlinechar
}%
\NewDocumentCommand{\runSomeCode}{}{%
  \runSomeCodeCatcodeBegingroup
  \runSomeCodeInternal
}%
\begingroup
\catcode`\^^M=12\relax%
\NewDocumentCommand{\runSomeCodeInternal}{+v+v}{%
  \endgroup%
  \NewDocumentCommand{\runSomeCodeInternal}{+v+v}{%
     \scantokens{\endgroup#1[##1]^^M##2^^M#2}%
     \ignorespaces%
  }%
}%
\runSomeCodeInternal{\begin{sympycode}}{\end{sympycode}}%

\NewDocumentCommand{\newCodeSnippet}{m}{%
  \runSomeCodeCatcodeBegingroup
  \newCodeSnippetInternal{#1}%
}%

\NewDocumentCommand{\newCodeSnippetInternal}{m+v+v}{%
  \endgroup
  \newcommand*{#1}[1][#2]{\scantokens{\runSomeCode{##1}{#3}}}%
  \ignorespaces
}%

\begin{document}

\newCodeSnippet{\functionExpression}{SessionA}{functionExpression = x**9 + 7*z}

\runSomeCode{SessionA}{x, z = symbols('x z')}
\functionExpression

\runSomeCode{SessionB}{
  x = 2
  z = 3
}
\functionExpression[SessionB]


\begin{equation*}
\sympy[SessionA]{x} = \sympy[SessionB]{x};
\sympy[SessionA]{z} = \sympy[SessionB]{z}
\to \frac{d}{dz} f\left(z\right) = \sympy[SessionA]{functionExpression} = \sympy[SessionB]{functionExpression}
\end{equation*}


\runSomeCode{SessionC}{
  x = 1
  z = 1
}
\functionExpression[SessionC]

\begin{equation*}
\sympy[SessionA]{x} = \sympy[SessionC]{x};
\sympy[SessionA]{z} = \sympy[SessionC]{z}
\to \frac{d}{dz} f\left(z\right)  = \sympy[SessionA]{functionExpression} = \sympy[SessionC]{functionExpression}
\end{equation*}


\end{document}

并通过 shell 命令编译两次

pdflatex -shell-escape test.tex

，然后我得到这个：

Question 2

我找到了一种适用于和的解决方案fancyvrb。pythontex此解决方案适用于fancyvrb该解决方案在文档中包filecontentsdef。希望这能帮助其他人解决看似常见问题的问题。

\usepackage[keeptemps, gobble=auto]{pythontex}
\usepackage{xparse}
\usepackage{filecontentsdef}

% [1] store tabs as active characters so they can be handled by fancyvrb
{\catcode`\^^I=\active\gdef\FCDtabtomacro{\noexpand^^I}}

% [2]
\begin{filecontentsdefmacro}{\testwe}
    x, z = symbols('x z')
    functionExpression = x**9 + 7*z
\end{filecontentsdefmacro}

% Define our macro that should execute the verbatim code block
\NewDocumentCommand\nestedcode{m}{{% [3]
    \renewcommand*\FCDprintenvname{sympycode}% [4]
    \renewcommand*\FCDprintenvoptions{% [5] environment options can be set
        \unexpanded{[#1]}%
    }%
    \filecontentsprint\testwe % [6] we could pass a csname here
    \frac{d}{dz} f\left(z\right) = \sympy[#1]{functionExpression}
}}

在您自己的文档中应用此解决方案的步骤如下：

根据filecontentsdef包，我们将标签保存为活动角色。
通过宏功能定义您的内容filecontentsdef。这些宏稍后将用作我们希望执行的代码的标识符。
构建任何你想要的宏。我利用了xparse在这里使用它是为了在“复杂”的调用层次结构中强调这段代码（如果有任何效果的话）。如果你想防止污染定义，那么将宏主体包装在一个组中按照正常的 LaTeX 惯例。
设置保存的宏希望扩展的环境
设置该环境接受的任何可选参数（例如的会话名称sympy）
调用\filecontentsprint以在所需的上下文中扩展已保存的内容。

为了演示所需的行为，以下文档：

\begin{document}
    An expression, nested within an equasion environment, producing text while
    modifying a session whose name was passed by argument:
    \begin{equation}
        \nestedcode{sessionname}
    \end{equation}

    Confirming that the session does, in fact, subsequently contain those symbols:
    \begin{equation}
        \sympy[sessionname]{x}
    \end{equation}
\end{document}

产生所需的输出。

Answer

我找到了一种适用于和的解决方案fancyvrb。pythontex此解决方案适用于fancyvrb该解决方案在文档中包filecontentsdef。希望这能帮助其他人解决看似常见问题的问题。

\usepackage[keeptemps, gobble=auto]{pythontex}
\usepackage{xparse}
\usepackage{filecontentsdef}

% [1] store tabs as active characters so they can be handled by fancyvrb
{\catcode`\^^I=\active\gdef\FCDtabtomacro{\noexpand^^I}}

% [2]
\begin{filecontentsdefmacro}{\testwe}
    x, z = symbols('x z')
    functionExpression = x**9 + 7*z
\end{filecontentsdefmacro}

% Define our macro that should execute the verbatim code block
\NewDocumentCommand\nestedcode{m}{{% [3]
    \renewcommand*\FCDprintenvname{sympycode}% [4]
    \renewcommand*\FCDprintenvoptions{% [5] environment options can be set
        \unexpanded{[#1]}%
    }%
    \filecontentsprint\testwe % [6] we could pass a csname here
    \frac{d}{dz} f\left(z\right) = \sympy[#1]{functionExpression}
}}

在您自己的文档中应用此解决方案的步骤如下：

根据filecontentsdef包，我们将标签保存为活动角色。
通过宏功能定义您的内容filecontentsdef。这些宏稍后将用作我们希望执行的代码的标识符。
构建任何你想要的宏。我利用了xparse在这里使用它是为了在“复杂”的调用层次结构中强调这段代码（如果有任何效果的话）。如果你想防止污染定义，那么将宏主体包装在一个组中按照正常的 LaTeX 惯例。
设置保存的宏希望扩展的环境
设置该环境接受的任何可选参数（例如的会话名称sympy）
调用\filecontentsprint以在所需的上下文中扩展已保存的内容。

为了演示所需的行为，以下文档：

\begin{document}
    An expression, nested within an equasion environment, producing text while
    modifying a session whose name was passed by argument:
    \begin{equation}
        \nestedcode{sessionname}
    \end{equation}

    Confirming that the session does, in fact, subsequently contain those symbols:
    \begin{equation}
        \sympy[sessionname]{x}
    \end{equation}
\end{document}

产生所需的输出。

Question 3

很明显，您必须为字符提供正确的 catcode，这可以通过以下方式完成：

正确的方法：查找包的文档，看看是否有任何命令可以在不改变 catcode 的情况下工作。

对于verbatim有\texttt，对于pythontex有\py和\pyc，对于listings有\lstinline。

也可以看看：
- 逐字逐句的新命令
- 命令中的逐字
手动方式：您必须以某种方式弄清楚环境需要哪些 catcode，然后手动将字符转换为正确的 catcode 并将其提供给环境。
自动方式等效（旧引擎）：将内容写入外部文件，\input该文件，然后（可选）删除该文件。
自动方式：使用合适的 catcodes 创建一个标记列表，然后\scantokens得出结果。 （用于以下答案）

没有其他办法，因为为了知道哪个 catcode 是正确的，你必须运行代码，一旦执行代码，就无法“撤消”效果。

下面的解决方案使用的\scantokens方法与其他答案...但希望更容易理解。

\documentclass{article}
\usepackage{fancyvrb}
\begin{document}
\ExplSyntaxOn
% ======== Define \my__tl_set_verbatim : similar to \tl_set:Nn, but second argument is of xparse's +v type. ========
\NewDocumentCommand \my__tl_set_verbatim {m +v} {
    \tl_set:Nn #1 {#2}
}
% ======== Define some auxiliary helper TLs. ========
\tl_set:Nx \my__newline_char_other_cat   {\char_generate:nn {`\^^M} {12}}  % A newline character with "other" category code.
\my__tl_set_verbatim \my__begin_verbatim {\begin{Verbatim}[frame=single, numbers=left]}
\my__tl_set_verbatim \my__end_verbatim   {\end{Verbatim}}
% ======== Define the main command. ========
\cs_set:Npn \my__command:n #1 {
    \exp_args:Nx \scantokens {
        \my__begin_verbatim     \my__newline_char_other_cat
            x~ =~ #1            \my__newline_char_other_cat
        \my__end_verbatim       \my__newline_char_other_cat
    }
}
% ======== Use that command. ========
\my__command:n {123}
\ExplSyntaxOff
\end{document}

该解决方案使用 fancyvrb 的Verbatim环境进行演示，但它应该适用于其他环境。

结果是：

当然，要使用\ExplSyntaxOn模式之外的命令，请定义一个适当命名的命令。

实用提示：

为了进行调试，将命令定义更改为

\cs_set:Npn \my__command:n #1 {
    \tl_set:Nx \my__tmp {
       \my__begin_verbatim     \my__newline_char_other_cat
          x~ =~ #1             \my__newline_char_other_cat
       \my__end_verbatim       \my__newline_char_other_cat
    }
    \tl_analysis_show:N \my__tmp
    \exp_args:NV \scantokens {
       \my__tmp
    }
}

查找文档以\tl_analysis_show:N获取更多信息。

不起作用的事情：
- 使用\detokenize{\end{Verbatim}}. 因为环境期望\end{Verbatim}完全按照而不是（和\end {Verbatim}之间有一个空格）来结束环境。\end{
- 在定义行中包含换行符\my__begin_verbatim：
```
\my__tl_set_verbatim \my__begin_verbatim {\begin{Verbatim}[frame=single, numbers=left]
}
```
  根据我的其他答案xparse 的+v参数将在模式下将换行符转换为空格字符\ExplSyntaxOn。（但是，切换到 \ExplSyntaxOff定义之前是有效的）

Answer