范式窗格

为给定单词生成范例的可安装包，给出指向范例布局和 FST 文件的指针。最初是为itwêwina建造的。

派皮包

发布到 PyPi 的最新版本包：paradigm-panes 0.3.2

安装

pip install paradigm-panes

发展

开发是通过Python Poetry包管理器完成和管理的。

开始开发：

# Download the repo
git clone https://github.com/UAlbertaALTLab/paradigm-panes.git

# Set up virutal env
virtualenv venv --python=python3.9
source venv/bin/activate

# Install dependencies
poetry install

# Now cd into main directory and try out the package
cd paradigm_panes
python
    >>> import paradigm_panes
    >>> ...

API 文档：

• PaneGenerator()

  为了成功执行，包需要一个指向资源的链接，如下所述。为了管理不同的链接并更有效地使用窗格生成器，该包提供了 PaneGenerator 类，该类允许管理设置和执行主要功能：

  >>> pane_generator = paradigm_panes.PaneGenerator()
  

  类本身不带任何变量。

• 生成窗格（）

  >>> paradigm = pane_generator.generate_pane(lemma, paradigm_type, size: Optional)
  

  此功能是包的核心功能。一旦指定了资源，这个函数就会根据给定的规范生成窗格。
  如果在 FST 文件中找不到翻译，则某些变形将被指示为缺失。生成的范例类被序列化并以 JSON 形式返回。

  参数：

  lemma(str) - 要变形的基本词形

  范式类型（str） - 单词范式类型的规范。前任。“不”。

  size(str) - 要返回的窗格的可选大小。目前支持“base”和“full”。如果未找到指定的大小，则使用默认选项覆盖。

• all_analysis_template_tags()

  >>> paradigm = pane_generator.all_analysis_template_tags(paradigm_type)
  

  返回所有分析模板标签的附加功能。

  参数：

  范式类型（str） - 单词范式类型的规范。前任。“不”。

  tag_style(str) - 要返回的标签样式。

  通过设置指定标签样式

使用和配置

导入库：

>>> import paradigm_panes

创建 PaneGenerator 并指定 FST 文件和布局资源的路径：

>>> pg = paradigm_panes.PaneGenerator()
>>> pg.set_layouts_dir("/home/ubuntu/paradigm_panes/resources/layouts")
>>> pg.set_fst_filepath("/home/ubuntu/paradigm_panes/resources/fst/crk-strict-generator.hfstol")

传递引理、范式类型和可选大小以生成窗格：

>>> lemma = "amisk"
>>> p_type = "NA"
>>> paradigm = pg.generate_pane(lemma, p_type)

>>> p_size = "full"
>>> full_paradigm = pg.generate_pane(lemma, p_type, p_size)

设置规范功能：

• set_layouts_dir(path)指定具有与当前范式生成相关的范式布局的目录的位置。

• set_fst_filepath(path)使用与当前范例生成相关的布局转换指定 FST 文件位置。

• set_tag_style(path)为 all_analysis_template_tags 函数指定模板渲染类型。

  可用的标签样式：

  1. “加”
  2. “括号”

生成器必须在生成范例之前指定两个位置（FST、布局）。

大小对于范式生成是可选的；默认情况下，将使用基本尺寸（或第一个可用尺寸）。

测试

要运行需要安装所需依赖项的测试，使用这样的虚拟环境会更容易：

>>> # Set up virutal env
>>> virtualenv venv --python=python3.9
>>> source venv/bin/activate
>>>
>>> # Install dependencies
>>> poetry install

安装依赖项后，您可以通过调用 pytest 来运行测试。

>>> pytest

发布

包版本号在 pyproject.toml 中排序。PyPi 的每个版本都需要更新。
在发布之前从主目录构建包：

>>> poetry build

要发布到 Test PyPi，请使用诗歌并输入与 Test PyPi 帐户关联的凭据

>>> poetry publish -r testpypi

要发布到真正的 PyPi，请使用诗歌并输入与 PyPi 关联的凭据

>>> poetry publish

所有相关的包规范和依赖项都在pyproject.toml文件中进行管理。