Text

class fileformats.text.Text(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: File

Base class for text files

class fileformats.text.Plain(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.TextFile(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Plain, UnicodeFile

class fileformats.text.Csv(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Tsv(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Html(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Markdown(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.RestructedText(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text._1d_interleaved_parityfec(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.CacheManifest(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: WithMagicNumber, Text, BinaryFile

class fileformats.text.Calendar(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

This media type is designed for widespread use by Internet calendaring and scheduling applications. In addition, applications in the workflow and document management area might find this content-type applicable. The iTIP [2446bis], iMIP [2447bis], and CalDAV [RFC4791] Internet protocols directly use this media type also.

class fileformats.text.Cql(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.CqlExpression(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.CqlIdentifier(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Css(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.CsvSchema(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Dns(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

DNS-related software, including software storing and using certificates stored in DNS.

class fileformats.text.Encaprtp(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Fhirpath(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Flexfec(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

Multimedia applications that want to improve resiliency against packet loss by sending redundant data in addition to the source media.

class fileformats.text.Fwdred(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

It is expected that real-time audio/video, text streaming, and conferencing tools/applications that want protection against losses of a large number of consecutive frames will be interested in using this type.

class fileformats.text.Gff3(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

TODO: Although no byte sequences can be counted on to always be present, GFF3 data in ASCII-compatible character sets (including UTF-8) often begin with hexadecimal 23 23 67 66 66 2d 76 65 72 73 69 6f 6e 20 33 ("##gff-version 3").

class fileformats.text.GrammarRefList(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

MRCPv2 clients and servers

class fileformats.text.Hl7v2(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Javascript(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

Script interpreters as discussed in RFC 9239.

class fileformats.text.JcrCnd(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

Used by content repositories that implement the Content Repository For Java API (JCR)

class fileformats.text.Mizar(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.N3(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

TODO: Notation3 documents may have the strings '@prefix' or '@base' (case dependent) near the beginning of the document.

class fileformats.text.Parameters(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

Applications that use RTSP and have additional parameters they like to read and set using the RTSP GET_PARAMETER and SET_PARAMETER methods.

class fileformats.text.Parityfec(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.ProvenanceNotation(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

TODO: PROV-N documents may have the strings 'document' near the beginning of the document.

class fileformats.text.Prs_Fallenstein_Rst(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Prs_Lines_Tag(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

TODO: All tag data streams start Tag-xxx-version - where xxx is the particular tag type.

class fileformats.text.Prs_Prop_Logic(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Raptorfec(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

Real-time multimedia applications like video streaming, audio streaming, and video conferencing.

class fileformats.text.Red(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Rfc822_headers(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.RichText(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.RtpEncAescm128(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Rtploopback(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Rtx(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Sgml(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Shaclc(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

An implementations of SHACLC is part of the TopQuadrant SHACL API

TODO: SHACLC documents will likely have the words PREFIX or BASE (case sensitive) near the beginning of the document. However, the same words may appear in Turtle and SPARQL documents.

class fileformats.text.Shex(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Spdx(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

The "charset" parameter is not used for the defined subtype because the charset information is transported inside the payload.

class fileformats.text.Strings(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.T140(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

This type is only defined for transfer via RTP.

class fileformats.text.Troff(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Turtle(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

TODO: Turtle documents may have the strings '@prefix' or '@base' (case dependent) near the beginning of the document.

class fileformats.text.Ulpfec(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

Multimedia applications that seek to improve resiliency to loss by sending additional data with the media stream.

class fileformats.text.UriList(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.Vcard(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

They are numerous, diverse, and include mail user agents, instant messaging clients, address book applications, directory servers, and customer relationship management software.

class fileformats.text.Vtt(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

Web browsers and other video players.

TODO: WebVTT files all begin with one of the following byte sequences (where "EOF" means the end of the file): EF BB BF 57 45 42 56 54 54 0A EF BB BF 57 45 42 56 54 54 0D EF BB BF 57 45 42 56 54 54 20 EF BB BF 57 45 42 56 54 54 09 EF BB BF 57 45 42 56 54 54 EOF 57 45 42 56 54 54 0A 57 45 42 56 54 54 0D 57 45 42 56 54 54 20 57 45 42 56 54 54 09 57 45 42 56 54 54 EOF (An optional UTF-8 BOM, the ASCII string "WEBVTT", and finally a space, tab, line break, or the end of the file.)

class fileformats.text.Wgsl(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile

class fileformats.text.XmlExternalParsedEntity(*fspaths: Iterable[str | Path] | str | Path | fileformats.core.FileSet, metadata: Dict[str, Any] | None = None, **load_kwargs: Any)[source]

Bases: Text, UnicodeFile