Module tf.parameters
Parameters
Fixed values for the whole program.
Expand source code Browse git
"""
# Parameters
Fixed values for the whole program.
"""
import os
import sys
from zipfile import ZIP_DEFLATED
VERSION = '12.0.7'
"""Program version.
This value is under control of the update process, as run by
`build.py` in the top-level directory of the repo.
"""
NAME = "Text-Fabric"
"""The name of the game: this program.
"""
BANNER = f"This is {NAME} {VERSION}"
PACK_VERSION = "3"
"""Data serialization version.
Plain text feature files will be compressed to zipped, pickled datastructures
that load must faster.
These methods evolve, sometimes in incompatible ways.
In those cases we bump this version number.
That will cause TF not to use compressed files that have been compressed by
older, incompatible methods.
Instead, TF will produce freshly compressed data files.
The compressed data files are stored in a directory `.tf/{PVN}/` next
to the original `tf` files, where `{PVN}` is the package version number.
See Also
--------
tf.clean
"""
API_VERSION = 3
"""TF API version.
Text-Fabric offers and API to TF apps.
This is the version that the current Text-Fabric offers to its apps.
Apps require a version. The provided version and the required version must
match exactly in order to get a working system.
We do not aim for backward compatibility, since it is very easy to obtain a new version
of an app.
When Text-Fabric loads a TF app, it will check the api version that the app requires
against this version.
App requirement higher than TF API version
: The user is advised to upgrade Text-Fabric, or, alternatively,
select an older version of the app
App requirement lower than TF API version
: The user is advised to obtain a newer version of the app, or alternatively,
downgrade Text-Fabric
"""
OTYPE = "otype"
"""Name of a central feature in a TF data set:
`otype` maps nodes to their types."""
OSLOTS = "oslots"
"""Name of a central feature in a TF data set:
`oslots` maps non-slot nodes to the sets of slots they occupy."""
OTEXT = "otext"
"""Name of a central (but optional) feature in a TF data set:
`otext` has configuration settings for sections, structure, and text formats."""
OVOLUME = "ovolume"
"""Name of the feature that maps nodes of a work dataset
to nodes in individual volumes in that work."""
OWORK = "owork"
"""Name of the feature that maps nodes in an individual volume of a work
to nodes in that work."""
OINTERF = "ointerfrom"
"""Name of the feature that stores the outgoing inter-volume edges
of a volume."""
OINTERT = "ointerto"
"""Name of the feature that stores the incoming inter-volume edges
of a volume."""
OMAP = "omap"
"""Name prefix of features with a node map from an older version to a newer version.
The full name of such a feature is `omap@`*oldversion*`-`*newversion*
"""
WARP = (OTYPE, OSLOTS, OTEXT)
"""The names of the central features of TF data sets.
The features `otype` and `oslots` are crucial to every TF dataset.
Without them, a dataset is not a TF dataset, although it could still be a
TF data module.
"""
GZIP_LEVEL = 2
"""Compression level when compressing tf files."""
PICKLE_PROTOCOL = 4
"""Pickle protocol level when pickling tf files."""
ORG = "annotation"
"""GitHub organization or GitLab group.
This is where the repo that contains Text-Fabric resides.
"""
REPO = "text-fabric"
"""GitHub repo or GitLab project.
This is the name of the repo that contains Text-Fabric.
"""
RELATIVE = "tf"
"""Default relative path with a repo to the directory with tf files.
"""
ON_IPAD = sys.platform == "darwin" and os.uname().machine.startswith("iP")
GH = "github"
"""Name of GitHub backend."""
GL = "gitlab"
"""Name of GitLab backend."""
URL_GH = "https://github.com"
"""Base url of GitHub."""
URL_GH_API = "https://api.github.com"
"""Base url of GitHub API."""
URL_GH_UPLOAD = "https://uploads.github.com"
"""Base url of GitHub upload end point."""
URL_GL = "https://gitlab.com"
"""Base url of GitLab."""
URL_GL_API = "https://api.gitlab.com"
"""Base url of GitLab API."""
URL_GL_UPLOAD = "https://uploads.gitlab.com"
"""Base url of GitLab upload end point."""
URL_NB = "https://nbviewer.jupyter.org"
"""Base url of NB-viewer."""
PROTOCOL = "http://"
HOST = "localhost"
PORT_BASE = 10000
DOI_DEFAULT = "no DOI"
DOI_URL_PREFIX = "https://doi.org"
DOI_TF = "10.5281/zenodo.592193"
"""DOI of an archived copy of this repo at Zenodo."""
BRANCH_DEFAULT = "master"
"""Default branch in repositories, older value."""
BRANCH_DEFAULT_NEW = "main"
"""Default branch in repositories, modern value."""
ZIP_OPTIONS = dict(compression=ZIP_DEFLATED)
"""Options for zip when packing tf files.
This is for packaging collections of plain tf files into zip files
to be attached to releases on GitHub/GitLab.
!!! caution "Not for .tfx files"
This is not the zipping as done when .tf files are
pickled and compressed to .tfx files.
"""
if sys.version_info[0] > 3 or sys.version_info[0] == 3 and sys.version_info[1] >= 7:
ZIP_OPTIONS["compresslevel"] = 6
YARN_RATIO = 1.25
"""Performance parameter in the `tf.search.search` module."""
TRY_LIMIT_FROM = 40
"""Performance parameter in the `tf.search.search` module."""
TRY_LIMIT_TO = 40
"""Performance parameter in the `tf.search.search` module."""
SEARCH_FAIL_FACTOR = 4
"""Limits fetching of search results to this times maxNode (corpus dependent)"""
Global variables
var API_VERSION
-
TF API version.
Text-Fabric offers and API to TF apps. This is the version that the current Text-Fabric offers to its apps.
Apps require a version. The provided version and the required version must match exactly in order to get a working system.
We do not aim for backward compatibility, since it is very easy to obtain a new version of an app.
When Text-Fabric loads a TF app, it will check the api version that the app requires against this version.
- App requirement higher than TF API version
- The user is advised to upgrade Text-Fabric, or, alternatively, select an older version of the app
- App requirement lower than TF API version
- The user is advised to obtain a newer version of the app, or alternatively, downgrade Text-Fabric
var BRANCH_DEFAULT
-
Default branch in repositories, older value.
var BRANCH_DEFAULT_NEW
-
Default branch in repositories, modern value.
var DOI_TF
-
DOI of an archived copy of this repo at Zenodo.
var GH
-
Name of GitHub backend.
var GL
-
Name of GitLab backend.
var GZIP_LEVEL
-
Compression level when compressing tf files.
var NAME
-
The name of the game: this program.
var OINTERF
-
Name of the feature that stores the outgoing inter-volume edges of a volume.
var OINTERT
-
Name of the feature that stores the incoming inter-volume edges of a volume.
var OMAP
-
Name prefix of features with a node map from an older version to a newer version.
The full name of such a feature is
omap@
oldversion-
newversion var ORG
-
GitHub organization or GitLab group.
This is where the repo that contains Text-Fabric resides.
var OSLOTS
-
Name of a central feature in a TF data set:
oslots
maps non-slot nodes to the sets of slots they occupy. var OTEXT
-
Name of a central (but optional) feature in a TF data set:
otext
has configuration settings for sections, structure, and text formats. var OTYPE
-
Name of a central feature in a TF data set:
otype
maps nodes to their types. var OVOLUME
-
Name of the feature that maps nodes of a work dataset to nodes in individual volumes in that work.
var OWORK
-
Name of the feature that maps nodes in an individual volume of a work to nodes in that work.
var PACK_VERSION
-
Data serialization version.
Plain text feature files will be compressed to zipped, pickled datastructures that load must faster.
These methods evolve, sometimes in incompatible ways. In those cases we bump this version number. That will cause TF not to use compressed files that have been compressed by older, incompatible methods. Instead, TF will produce freshly compressed data files.
The compressed data files are stored in a directory
.tf/{PVN}/
next to the originaltf
files, where{PVN}
is the package version number.See Also
var PICKLE_PROTOCOL
-
Pickle protocol level when pickling tf files.
var RELATIVE
-
Default relative path with a repo to the directory with tf files.
var REPO
-
GitHub repo or GitLab project.
This is the name of the repo that contains Text-Fabric.
var SEARCH_FAIL_FACTOR
-
Limits fetching of search results to this times maxNode (corpus dependent)
var TRY_LIMIT_FROM
-
Performance parameter in the
tf.search.search
module. var TRY_LIMIT_TO
-
Performance parameter in the
tf.search.search
module. var URL_GH
-
Base url of GitHub.
var URL_GH_API
-
Base url of GitHub API.
var URL_GH_UPLOAD
-
Base url of GitHub upload end point.
var URL_GL
-
Base url of GitLab.
var URL_GL_API
-
Base url of GitLab API.
var URL_GL_UPLOAD
-
Base url of GitLab upload end point.
var URL_NB
-
Base url of NB-viewer.
var VERSION
-
Program version.
This value is under control of the update process, as run by
build.py
in the top-level directory of the repo. var WARP
-
The names of the central features of TF data sets.
The features
otype
andoslots
are crucial to every TF dataset. Without them, a dataset is not a TF dataset, although it could still be a TF data module. var YARN_RATIO
-
Performance parameter in the
tf.search.search
module. var ZIP_OPTIONS
-
Options for zip when packing tf files.
This is for packaging collections of plain tf files into zip files to be attached to releases on GitHub/GitLab.
Not for .tfx files
This is not the zipping as done when .tf files are pickled and compressed to .tfx files.