Welcome to pythonimmediate’s documentation!

This package is a Python-TeX binding. It requires the pythonimmediate TeX package to be installed.

The package works both ways – you can run Python code from TeX, or TeX code from Python.

There are different sections of the documentation:

• pythonimmediate.simple – interface that “just works” for typical users of the pythonimmediate TeX package, to use Python coding from TeX, who does not know TeX inner details such as category codes.

  Note that this should be read in conjunction with the pythonimmediate TeX package documentation.

• Some properties of the parent TeX interpreter can be accessed from default_engine.

• The rest: contain functions to control the precise category codes of the tokens.

  Read expand_once() and NTokenList for some examples.

• See the documentation of pythonimmediate.engine.ChildProcessEngine for ways to create a TeX engine from inside Python, and explanation of the engine= optional argument for most functions.

• The command-line arguments that the Python component accepts (can be specified through the args= TeX module option) are documented in pythonimmediate.pytotex.

Contents:

• pythonimmediate package
  • Submodules
  • pythonimmediate.communicate module
    • Communicator
      • Communicator.character
      • Communicator.is_available()
      • Communicator.send()
      • Communicator.setup()
    • GlobalConfiguration
      • GlobalConfiguration.communicator
      • GlobalConfiguration.debug
      • GlobalConfiguration.debug_force_buffered
      • GlobalConfiguration.from_args()
      • GlobalConfiguration.naive_flush
      • GlobalConfiguration.sanity_check_extra_line
    • MultiprocessingNetworkCommunicator
      • MultiprocessingNetworkCommunicator.connection
      • MultiprocessingNetworkCommunicator.is_available()
      • MultiprocessingNetworkCommunicator.port
      • MultiprocessingNetworkCommunicator.send()
      • MultiprocessingNetworkCommunicator.setup()
    • UnnamedPipeCommunicator
      • UnnamedPipeCommunicator.connection
      • UnnamedPipeCommunicator.fileno
      • UnnamedPipeCommunicator.is_available()
      • UnnamedPipeCommunicator.pid
      • UnnamedPipeCommunicator.send()
      • UnnamedPipeCommunicator.setup()
  • pythonimmediate.copy_to_stderr module
  • pythonimmediate.decode_8bit module
  • pythonimmediate.engine module
    • ChildProcessEngine
      • ChildProcessEngine.close()
      • ChildProcessEngine.get_process()
    • DefaultEngine
      • DefaultEngine.config
      • DefaultEngine.engine
      • DefaultEngine.get_engine()
      • DefaultEngine.name
      • DefaultEngine.set_engine()
    • Engine
      • Engine.check_not_exited()
      • Engine.check_not_exited_after()
      • Engine.check_not_exited_before()
      • Engine.check_not_finished()
      • Engine.config
      • Engine.is_unicode
      • Engine.name
      • Engine.read()
      • Engine.write()
    • ParentProcessEngine
    • SetDefaultEngineContextManager
      • SetDefaultEngineContextManager.old_engine
    • debug_possibly_shorten()
    • default_engine
  • pythonimmediate.pytotex module
    • get_parser()
  • pythonimmediate.simple module
    • define_char()
    • execute()
    • f1()
    • fully_expand()
    • get_arg_estr()
    • get_arg_str()
    • get_multiline_verb_arg()
    • get_next_char()
    • get_optional_arg_estr()
    • get_optional_arg_str()
    • get_verb_arg()
    • is_balanced()
    • newcommand()
    • newenvironment()
    • newenvironment_verb()
    • peek_next_char()
    • print_TeX()
    • put_next()
    • renewcommand()
    • run_tokenized_line_local()
    • split_balanced()
    • strip_optional_braces()
    • undefine_char()
    • var
  • pythonimmediate.textopy module
    • main()
  • Module contents
    • BalancedTokenList
      • BalancedTokenList.detokenize()
      • BalancedTokenList.execute()
      • BalancedTokenList.expand_o()
      • BalancedTokenList.expand_x()
      • BalancedTokenList.get_next()
      • BalancedTokenList.put_next()
    • BlueToken
      • BlueToken.no_blue
      • BlueToken.noexpand
      • BlueToken.put_next()
      • BlueToken.repr1()
      • BlueToken.token
    • C
    • Catcode
      • Catcode.active
      • Catcode.alignment
      • Catcode.begin_group
      • Catcode.bgroup
      • Catcode.comment
      • Catcode.egroup
      • Catcode.end_group
      • Catcode.end_of_line
      • Catcode.escape
      • Catcode.for_token
      • Catcode.ignored
      • Catcode.invalid
      • Catcode.letter
      • Catcode.line
      • Catcode.math
      • Catcode.math_subscript
      • Catcode.math_superscript
      • Catcode.math_toggle
      • Catcode.other
      • Catcode.paragraph
      • Catcode.param
      • Catcode.parameter
      • Catcode.space
      • Catcode.subscript
      • Catcode.superscript
    • CharacterToken
      • CharacterToken.assignable
      • CharacterToken.can_blue
      • CharacterToken.catcode
      • CharacterToken.chr
      • CharacterToken.degree()
      • CharacterToken.index
      • CharacterToken.repr1()
      • CharacterToken.serialize()
      • CharacterToken.simple_detokenize()
      • CharacterToken.str_unicode()
    • ControlSequenceToken
      • ControlSequenceToken.assignable
      • ControlSequenceToken.can_blue
      • ControlSequenceToken.csname
      • ControlSequenceToken.make
      • ControlSequenceToken.repr1()
      • ControlSequenceToken.serialize()
      • ControlSequenceToken.simple_detokenize()
    • ControlSequenceTokenMaker
    • FrozenRelaxToken
      • FrozenRelaxToken.assignable
      • FrozenRelaxToken.can_blue
      • FrozenRelaxToken.repr1()
      • FrozenRelaxToken.serialize()
      • FrozenRelaxToken.simple_detokenize()
    • NToken
      • NToken.degree()
      • NToken.meaning_equal()
      • NToken.meaning_str()
      • NToken.no_blue
      • NToken.noexpand
      • NToken.put_next()
      • NToken.repr1()
      • NToken.str_unicode()
    • NTokenList
      • NTokenList.bool()
      • NTokenList.execute()
      • NTokenList.expand_x()
      • NTokenList.force_token_list()
      • NTokenList.is_balanced()
      • NTokenList.put_next()
      • NTokenList.simple_parts()
      • NTokenList.str()
      • NTokenList.str_unicode()
    • PTTBalancedTokenList
      • PTTBalancedTokenList.data
      • PTTBalancedTokenList.read_code()
      • PTTBalancedTokenList.serialize()
    • PTTBlock
      • PTTBlock.data
      • PTTBlock.read_code()
      • PTTBlock.serialize()
    • PTTInt
      • PTTInt.data
      • PTTInt.read_code()
      • PTTInt.serialize()
    • PTTTeXLine
      • PTTTeXLine.data
      • PTTTeXLine.read_code()
      • PTTTeXLine.serialize()
    • PTTVerbatimLine
      • PTTVerbatimLine.data
      • PTTVerbatimLine.read_code()
      • PTTVerbatimLine.serialize()
    • PTTVerbatimRawLine
      • PTTVerbatimRawLine.data
      • PTTVerbatimRawLine.read_code()
      • PTTVerbatimRawLine.serialize()
    • PyToTeXData
      • PyToTeXData.read_code()
      • PyToTeXData.serialize()
    • PythonCallTeXFunctionType
    • PythonCallTeXSyncFunctionType
    • Python_call_TeX_data
      • Python_call_TeX_data.TeX_code
      • Python_call_TeX_data.finish
      • Python_call_TeX_data.recursive
      • Python_call_TeX_data.sync
    • Python_call_TeX_extra
      • Python_call_TeX_extra.ptt_argtypes
      • Python_call_TeX_extra.ttp_argtypes
    • Python_call_TeX_local()
    • RedirectPrintTeX
    • TTPBalancedTokenList
      • TTPBalancedTokenList.read()
      • TTPBalancedTokenList.send_code()
      • TTPBalancedTokenList.send_code_var()
    • TTPBlock
      • TTPBlock.read()
      • TTPBlock.send_code()
      • TTPBlock.send_code_var()
    • TTPEBlock
      • TTPEBlock.read()
      • TTPEBlock.send_code()
      • TTPEBlock.send_code_var()
    • TTPELine
      • TTPELine.read()
      • TTPELine.send_code()
      • TTPELine.send_code_var()
    • TTPEmbeddedLine
      • TTPEmbeddedLine.read()
      • TTPEmbeddedLine.send_code()
      • TTPEmbeddedLine.send_code_var()
    • TTPLine
      • TTPLine.read()
      • TTPLine.send_code()
      • TTPLine.send_code_var()
    • TTPRawLine
      • TTPRawLine.read()
      • TTPRawLine.send_code()
      • TTPRawLine.send_code_var()
    • TeXToPyData
      • TeXToPyData.read()
      • TeXToPyData.send_code()
      • TeXToPyData.send_code_var()
    • Token
      • Token.assign()
      • Token.assign_future()
      • Token.assign_futurenext()
      • Token.assign_value()
      • Token.assignable
      • Token.blue
      • Token.can_blue
      • Token.deserialize()
      • Token.deserialize_bytes()
      • Token.get_next()
      • Token.no_blue
      • Token.noexpand
      • Token.peek_next()
      • Token.put_next()
      • Token.serialize()
      • Token.simple_detokenize()
      • Token.value()
      • Token.value_str()
    • TokenList
      • TokenList.balanced
      • TokenList.balanced_parts()
      • TokenList.bool()
      • TokenList.check_balanced()
      • TokenList.deserialize()
      • TokenList.deserialize_bytes()
      • TokenList.doc()
      • TokenList.e3()
      • TokenList.execute()
      • TokenList.expand_x()
      • TokenList.force_token_list()
      • TokenList.from_string()
      • TokenList.is_balanced()
      • TokenList.iterable_from_string()
      • TokenList.put_next()
      • TokenList.serialize()
      • TokenList.serialize_bytes()
      • TokenList.simple_detokenize()
      • TokenList.str()
      • TokenList.str_unicode()
    • bootstrap_code_functions
    • build_Python_call_TeX()
    • can_be_mangled_to()
    • check_line()
    • continue_until_passed_back()
    • continue_until_passed_back_str()
    • debug()
    • define_Python_call_TeX()
    • define_TeX_call_Python()
    • define_internal_handler()
    • eval_with_linecache()
    • exec_or_eval_with_linecache()
    • exec_with_linecache()
    • expand_once()
    • export_function_to_module()
    • get_bootstrap_code()
    • get_random_identifier()
    • have_naive_replace()
    • mark_bootstrap()
    • mark_bootstrap_naive_replace()
    • naive_replace()
    • normalize_line()
    • parse_meaning_str()
    • peek_next_meaning()
    • postprocess_send_code()
    • py()
    • pyc()
    • pycq()
    • pyfile()
    • random_identifiers()
    • read_block()
    • readline()
    • run_block_finish()
    • run_block_local()
    • run_code_redirect_print_TeX()
    • run_error_finish()
    • run_main_loop()
    • run_main_loop_get_return_one()
    • run_none_finish()
    • run_tokenized_line_peek()
    • scan_Python_call_TeX()
    • scan_Python_call_TeX_module()
    • send_bootstrap_code()
    • send_finish()
    • send_raw()
    • substitute_private()
    • surround_delimiter()
    • template_substitute()
    • user_documentation()
    • wrap_naive_replace()

Indices and tables

• Index

• Module Index

• Search Page