phystool.pdbfile
Module Contents
Classes
Data
API
- phystool.pdbfile.logger
“getLogger(…)”
- class phystool.pdbfile.PDBFile(tex_file: pathlib.Path)
Bases:
abc.ABC- PDB_TYPE: str
None
- classmethod validate_type(list_of_types: str) list[str]
- classmethod open_unkown(tex_file: pathlib.Path) Self
- classmethod open(uuid: str) Self
- parse_texfile() bool
Parse a texfile to analyse its metadata. Does not save anything.
- save() None
- pytex() bool
- cat() None
- abstract to_dict() dict[str, str | dict | list[str]]
Return a dict that is JSON compatible
- abstract tex_export() None
Print a string that can be inserted in LexTeX file
- zip() None
- create_tmp_tex_file() pathlib.Path
- should_compile() bool
- compile() bool
- class phystool.pdbfile.Exercise(pdb_file: pathlib.Path, pdb_data: dict)
Bases:
phystool.pdbfile.PDBFile,phystool.pdbfile.CheckForTikzMixin- PDB_TYPE
“exercise”
- EXO_PATTERN
“compile(…)”
- TITLE_PATTERN
“compile(…)”
- to_dict() dict[str, str | dict | list[str]]
- tex_export() None
- class phystool.pdbfile.Theory(pdb_file: pathlib.Path, pdb_data: dict)
Bases:
phystool.pdbfile.PDBFile,phystool.pdbfile.CheckForTikzMixin- PDB_TYPE
“theory”
- THE_PATTERN
“compile(…)”
- TITLE_PATTERN
“compile(…)”
- to_dict() dict[str, str | dict | list[str]]
- tex_export() None
- class phystool.pdbfile.TP(pdb_file: pathlib.Path, pdb_data: dict)
Bases:
phystool.pdbfile.PDBFile,phystool.pdbfile.CheckForTikzMixin- PDB_TYPE
“tp”
- TP_STUDENT_PATTERN
“compile(…)”
- TITLE_PATTERN
“compile(…)”
- to_dict() dict[str, str | dict | list[str]]
- tex_export() None
- class phystool.pdbfile.QCM(pdb_file: pathlib.Path, pdb_data: dict)
Bases:
phystool.pdbfile.PDBFile,phystool.pdbfile.CheckForTikzMixin- PDB_TYPE
“qcm”
- QCM_PATTERN
“compile(…)”
- to_dict() dict[str, str | dict | list[str]]
- tex_export() None
- class phystool.pdbfile.Figure(pdb_file: pathlib.Path, pdb_data: dict)
Bases:
phystool.pdbfile.PDBFile- PDB_TYPE
“figure”
- FIG_PATTERN
“compile(…)”
- to_dict() dict[str, str | dict | list[str]]
- tex_export() None
- create_tmp_tex_file() pathlib.Path
- phystool.pdbfile.FILE_TYPE_MAP
None
- phystool.pdbfile.VALID_TYPES
“list(…)”