Merge pull request #336 from delph-in/v1.6.0

V1.6.0

Author: goodmami

CHANGELOG.md

@@ -1,6 +1,24 @@
 # Change Log
 
-## Unreleased
+## [v1.6.0]
+
+**Release date: 2021-09-30**
+
+### Added
+
+* REPP mask (`=`) operator and full masking support ([#331])
+
+### Fixed
+
+* SimpleDMRS no longer requires `index` or `top` to be specified when
+  decoding ([#334])
+* DMRX codec now conforms to the DTD regarding the upper/lower case of
+  attributes ([#333])
+
+### Changed
+
+* REPP no longer requires iterative group calls to appear after the
+  group definitions ([#308])
 
 
 ## [v1.5.1]
@@ -488,17 +506,18 @@ documented.
 **Release date: 2018-10-20**
 
 This release introduces a completely redone TDL parser that follows
-the description of TDL syntax at http://moin.delph-in.net/TdlRfc based
-on recent discussions on the DELPH-IN mailing list (links to these
-discussions are at the bottom of the linked wiki). In addition, there
-are three other major introductions: `delphin.commands`, which gives
+the description of TDL syntax at
+https://github.com/delph-in/docs/wiki/TdlRFC based on recent
+discussions on the DELPH-IN mailing list (links to these discussions
+are at the bottom of the linked wiki). In addition, there are three
+other major introductions: `delphin.commands`, which gives
 programmatic access to the `delphin` command-line utilities;
 `delphin.tsql`, which implements a subset of the TSQL query language
-(see http://moin.delph-in.net/TsqlRfc) that now replace the --filter
-options for certain commands; and the new `TypeHierarchy` class in
-`delphin.tfs`. Improvements to the `delphin.itsdb.TestSuite` class
-now give it feature-parity with the `ItsdbProfile` class it replaces.
-See the rest of the changelog for additional improvements.
+(see https://github.com/delph-in/docs/wiki/TsqlRfc) that now replace
+the --filter options for certain commands; and the new `TypeHierarchy`
+class in `delphin.tfs`. Improvements to the `delphin.itsdb.TestSuite`
+class now give it feature-parity with the `ItsdbProfile` class it
+replaces.  See the rest of the changelog for additional improvements.
 
 ### Fixed
 
@@ -1327,6 +1346,7 @@ There was no CHANGELOG file prior to this release, so I don't have much
 information about changes, except for
 [commit messages](../../commits/v0.2).
 
+[v1.6.0]: ../../releases/tag/v1.6.0
 [v1.5.1]: ../../releases/tag/v1.5.1
 [v1.5.0]: ../../releases/tag/v1.5.0
 [v1.4.1]: ../../releases/tag/v1.4.1
@@ -1493,7 +1513,11 @@ information about changes, except for
 [#303]: https://github.com/delph-in/pydelphin/issues/303
 [#304]: https://github.com/delph-in/pydelphin/issues/304
 [#306]: https://github.com/delph-in/pydelphin/issues/306
+[#308]: https://github.com/delph-in/pydelphin/issues/308
 [#316]: https://github.com/delph-in/pydelphin/issues/316
 [#319]: https://github.com/delph-in/pydelphin/issues/319
 [#323]: https://github.com/delph-in/pydelphin/issues/323
 [#324]: https://github.com/delph-in/pydelphin/issues/324
+[#331]: https://github.com/delph-in/pydelphin/issues/331
+[#333]: https://github.com/delph-in/pydelphin/issues/333
+[#334]: https://github.com/delph-in/pydelphin/issues/334

CONTRIBUTING.md

@@ -4,6 +4,7 @@ The easiest way to contribute to PyDelphin is to try it out and enter
 bug reports and feature requests. If you're contributing code, fork
 the repository and make pull requests to the `develop` branch.
 
+
 ## Filing issues
 
 File issues here: https://github.com/delph-in/pydelphin/issues
@@ -13,7 +14,10 @@ Please use the issue tracker for:
 * bug reports
 * feature requests
 * documentation requests
-* PyDelphin questions
+
+Questions about PyDelphin can be asked on the [DELPH-IN Discourse
+site](https://delphinqa.ling.washington.edu/) in the "PyDelphin Tools"
+category.
 
 For bug requests, please provide the following, if possible:
 
@@ -23,15 +27,16 @@ For bug requests, please provide the following, if possible:
   ```python
   >>> from delphin.__about__ import __version__
   >>> __version__  # distribution version
-  '1.5.0'
+  '1.6.0'
   >>> from delphin import mrs
   >>> mrs.__version__  # package version
-  '1.5.0'
+  '1.6.0'
   ```
 * Python version (e.g. 3.6, 3.7, etc.)
 
 For feature requests, please provide a use case for the feature.
 
+
 ## Submitting code
 
 Please follow these guidelines for code and repository changes:
@@ -44,9 +49,10 @@ Please follow these guidelines for code and repository changes:
   classes when standard Python data structures are sufficient
 * In implementing DELPH-IN formalisms and formats, aim first to be
   correct and complete (according to documentation at
-  http://moin.delph-in.net/; if a wiki doesn't exist, it's a good idea
-  to make one), and secondly convenient. Avoid adding features that
-  aren't part of the spec and would have limited utility.
+  https://github.com/delph-in/docs/wiki/; if a wiki doesn't exist,
+  it's a good idea to make one), and secondly convenient. Avoid adding
+  features that aren't part of the spec and would have limited
+  utility.
 * PyDelphin is primarily a library, not an application, so application
   code in general belongs in separate repositories. Applications can,
   however, make use of the `delphin` namespace.
@@ -55,11 +61,12 @@ Please follow these guidelines for code and repository changes:
   functions. Follow [Google-style docstrings] and use
   [reStructuredText] for formatting.
 
-### Testing
+### Creating a Development Environment
 
-Always run the unit tests before committing. First, from a terminal
-with PyDelphin's top-level directory as the current working directory,
-create a virtual environment (the following assumes you have Python 3
+In order to run the tests and build the documentation you'll need to
+create a development environment: a virtual environment with the
+dependencies installed. First create and activate a virtual
+environment from a terminal (the following assumes you have Python 3
 installed; the commands may differ depending on your operating system
 and choice of shell):
 
@@ -82,36 +89,42 @@ then install PyDelphin's dependencies and run tests with the current
 version of Python:
 
 ```console
-$ pip install .[test]
-$ pytest
-...
+$ pip install -e .[dev]
 ```
 
-To run the tests for all supported versions of Python, a tool like
-[Tox](https://tox.readthedocs.io/) is helpful. First install `tox`:
+The `-e` option is an "editable" install, meaning that Python will use
+the source files directly (via symlinks) instead of copying them into
+the virtual environment. The benefit is that you won't have to
+reinstall each time you make a change. The `[dev]` extra installs all
+dependencies for testing, building documentation, and uploading
+releases. If you just want to run the unit tests, the `[tests]` extra
+is sufficient.
 
-```console
-$ pip install tox
-```
+### Testing
 
-Then create a `tox.ini` file in the same directory as `setup.py`:
+Always run the unit tests before committing. Simply run pytest from
+PyDelphin's top directory to run the unit tests:
 
-    [tox]
-    envlist = py36,py37,py38,py39
+```console
+$ pytest
+```
 
-    [testenv]
-    usedevelop = True
-    extras = tests
-    commands = pytest
+Note that passing the tests for one version of Python may not be
+sufficient for the code to be accepted; it must pass the tests against
+all supported versions of Python.
 
-Then you can run `tox` which will create virtual environments and run
-`pytest` for each version (note: you need to have each of those
-versions of Python installed for it to work):
+The commands for linting (style and type checking) need some
+configuration:
 
 ```console
-$ tox
+$ flake8 delphin --extend-ignore E221
+$ mypy delphin --namespace-packages --explicit-package-bases --ignore-missing-imports
 ```
 
+These tests will be run automatically when a commit is pushed or pull
+request is submitted against the `develop` branch, but it's often more
+convenient to run it locally before pushing commits.
+
 ### Test Coverage
 
 Compute test coverage by installing
@@ -122,6 +135,7 @@ Compute test coverage by installing
 Note that the codebase doesn't yet have full test coverage.
 Contributions of unit tests are very welcome!
 
+
 ## Documentation
 
 The documentation resides in the `docs/` subdirectory, which contains

README.md

@@ -2,22 +2,23 @@
 
 [![PyPI Version](https://img.shields.io/pypi/v/pydelphin.svg)](https://pypi.org/project/PyDelphin/)
 ![Python Support](https://img.shields.io/pypi/pyversions/pydelphin.svg)
-[![Test Status](https://github.com/delph-in/pydelphin/workflows/tests/badge.svg)](https://github.com/delph-in/pydelphin/actions?query=workflow%3A%22tests%22)
+[![Test Status](https://github.com/delph-in/pydelphin/actions/workflows/checks.yml/badge.svg)](https://github.com/delph-in/pydelphin/actions/workflows/checks.yml)
 [![Documentation Status](https://readthedocs.org/projects/pydelphin/badge/?version=latest)](https://pydelphin.readthedocs.io/en/latest/?badge=latest)
+![Discourse topics](https://img.shields.io/discourse/topics?color=%234b2e83&server=https%3A%2F%2Fdelphinqa.ling.washington.edu)
 
 [DELPH-IN](http://delph-in.net) is an international consortium of
 researchers committed to producing precise, high-quality language
 processing tools and resources, primarily in the
 [HPSG](http://hpsg.stanford.edu/) syntactic and
-[MRS](http://moin.delph-in.net/RmrsTop) semantic frameworks, and
-PyDelphin is a suite of Python libraries for processing data and
-interacting with tools in the DELPH-IN ecosystem. PyDelphin's goal is
-to lower the barriers to making use of DELPH-IN resources to help
-users quickly build applications or perform experiments, and it has
-been successfully used for research into machine translation (e.g.,
-[Goodman, 2018]), sentence chunking ([Muszyńska, 2016]), neural
-semantic parsing ([Buys & Blunsom, 2017]), natural language
-generation ([Hajdik et al., 2019]), and more.
+[MRS](https://github.com/delph-in/docs/wiki/RmrsTop) semantic
+frameworks, and PyDelphin is a suite of Python libraries for
+processing data and interacting with tools in the DELPH-IN
+ecosystem. PyDelphin's goal is to lower the barriers to making use of
+DELPH-IN resources to help users quickly build applications or perform
+experiments, and it has been successfully used for research into
+machine translation (e.g., [Goodman, 2018]), sentence chunking
+([Muszyńska, 2016]), neural semantic parsing ([Buys & Blunsom, 2017]),
+natural language generation ([Hajdik et al., 2019]), and more.
 
 [Goodman, 2018]: https://goodmami.org/static/goodman-dissertation.pdf
 [Muszyńska, 2016]: https://www.aclweb.org/anthology/P16-3014
@@ -55,38 +56,38 @@ an issue][issues].
 PyDelphin contains the following modules:
 
 Semantic Representations:
-- [`delphin.mrs`]:  [Minimal Recursion Semantics](http://moin.delph-in.net/MrsRfc)
-- [`delphin.eds`]:  [Elementary Dependency Structures](http://moin.delph-in.net/EdsTop)
-- [`delphin.dmrs`]: [Dependency Minimal Recursion Semantics](http://moin.delph-in.net/RmrsDmrs)
+- [`delphin.mrs`]:  [Minimal Recursion Semantics](https://github.com/delph-in/docs/wiki/MrsRfc)
+- [`delphin.eds`]:  [Elementary Dependency Structures](https://github.com/delph-in/docs/wiki/EdsTop)
+- [`delphin.dmrs`]: [Dependency Minimal Recursion Semantics](https://github.com/delph-in/docs/wiki/RmrsDmrs)
 
 Semantic Components and Interfaces:
-- [`delphin.semi`]:      [Semantic Interface](http://moin.delph-in.net/SemiRfc)
-- [`delphin.vpm`]:       [Variable Property Mapping](http://moin.delph-in.net/RmrsVpm)
+- [`delphin.semi`]:      [Semantic Interface](https://github.com/delph-in/docs/wiki/SemiRfc)
+- [`delphin.vpm`]:       [Variable Property Mapping](https://github.com/delph-in/docs/wiki/RmrsVpm)
 - [`delphin.variable`]:  MRS variables
-- [`delphin.predicate`]: [Semantic Predicates](http://moin.delph-in.net/PredicateRfc)
+- [`delphin.predicate`]: [Semantic Predicates](https://github.com/delph-in/docs/wiki/PredicateRfc)
 - [`delphin.scope`]:     Underspecified scope
 - [`delphin.sembase`]:   Basic semantic structures
 - [`delphin.codecs`]:    A wide variety of serialization codecs for MRS, EDS, and DMRS
 
 Grammar and Parse Inspection:
-- [`delphin.derivation`]: [Derivation trees](http://moin.delph-in.net/ItsdbDerivations)
-- [`delphin.tdl`]:        [Type-Description Language](http://moin.delph-in.net/TdlRfc)
+- [`delphin.derivation`]: [Derivation trees](https://github.com/delph-in/docs/wiki/ItsdbDerivations)
+- [`delphin.tdl`]:        [Type-Description Language](https://github.com/delph-in/docs/wiki/TdlRfc)
 - [`delphin.tfs`]:        Feature structures and type hierarchies
 
 Tokenization:
-- [`delphin.repp`]:   [Regular-Expression PreProcessor](http://moin.delph-in.net/ReppTop)
-- [`delphin.tokens`]: [YY Token lattices](http://moin.delph-in.net/PetInput#YY_Input_Mode)
+- [`delphin.repp`]:   [Regular-Expression PreProcessor](https://github.com/delph-in/docs/wiki/ReppTop)
+- [`delphin.tokens`]: [YY Token lattices](https://github.com/delph-in/docs/wiki/PetInput#yy-input-mode)
 - [`delphin.lnk`]:    Lnk surface alignments
 
 Corpus Management and Processing:
-- [`delphin.itsdb`]: [\[incr tsdb()\]](http://moin.delph-in.net/ItsdbTop) profiles
+- [`delphin.itsdb`]: [\[incr tsdb()\]](https://github.com/delph-in/docs/wiki/ItsdbTop) profiles
 - [`delphin.tsdb`]: Low-level interface to test suite databases
-- [`delphin.tsql`]:  [TSQL](http://moin.delph-in.net/TsqlRfc) test suite queries
+- [`delphin.tsql`]:  [TSQL](https://github.com/delph-in/docs/wiki/TsqlRfc) test suite queries
 
 Interfaces with External Processors:
 - [`delphin.interface`]: Structures for interacting with external processors
 - [`delphin.ace`]:       Python wrapper for common tasks using [ACE](http://sweaglesw.org/linguistics/ace/)
-- [`delphin.web`]:       Client for the [web API](http://moin.delph-in.net/ErgApi)
+- [`delphin.web`]:       Client for the [web API](https://github.com/delph-in/docs/wiki/ErgApi)
 
 Core Components and Command Line Interface:
 - [`delphin.commands`]:   Functional interface to common tasks
@@ -128,7 +129,7 @@ Core Components and Command Line Interface:
 ### Getting Help
 
 Please use the [issue tracker][issues] for bug reports, feature
-requests, and PyDelphin-specific questions. For more general questions
+requests, and documentation requests. For more general questions
 and support, try one of the following channels maintained by the
 DELPH-IN community:
 
@@ -162,20 +163,20 @@ requests. Also thanks to the users of PyDelphin!
 ### Related Software
 
 * Parser/Generators (chronological order)
-  - LKB: http://moin.delph-in.net/LkbTop (also: http://moin.delph-in.net/LkbFos)
-  - PET: http://moin.delph-in.net/PetTop
+  - LKB: https://github.com/delph-in/docs/wiki/LkbTop (also: https://github.com/delph-in/docs/wiki/LkbFos)
+  - PET: https://github.com/delph-in/docs/wiki/PetTop
   - ACE: http://sweaglesw.org/linguistics/ace/
-  - agree: http://moin.delph-in.net/AgreeTop
+  - agree: https://github.com/delph-in/docs/wiki/AgreeTop
 * Grammar profiling, testing, and analysis
   - \[incr tsdb()\]: http://www.delph-in.net/itsdb/
   - gDelta: https://github.com/ned2/gdelta
   - Typediff: https://github.com/ned2/typediff
 * Software libraries and repositories
-  - LOGON: http://moin.delph-in.net/LogonTop
+  - LOGON: https://github.com/delph-in/docs/wiki/LogonTop
   - pydmrs: https://github.com/delph-in/pydmrs
 * Also see (may have overlap with the above):
-  - http://moin.delph-in.net/ToolsTop
-  - http://moin.delph-in.net/DelphinApplications
+  - https://github.com/delph-in/docs/wiki/ToolsTop
+  - https://github.com/delph-in/docs/wiki/DelphinApplications
 
 ### Spelling
 

delphin/__about__.py

@@ -3,7 +3,7 @@
 # the warehouse project:
 #   https://github.com/pypa/warehouse/blob/master/warehouse/__about__.py
 
-__version__ = '1.5.1'
+__version__ = '1.6.0'
 __version_info__ = __version__.replace('.', ' ').replace('-', ' ').split()
 
 __title__ = 'PyDelphin'

delphin/ace.py

@@ -571,7 +571,7 @@ def generate(grm: util.PathLike,
 
 # The following defines the command-line options available for users to
 # specify in ACEProcess tasks. For a description of these options, see:
-#     http://moin.delph-in.net/AceOptions
+#     https://github.com/delph-in/docs/wiki/AceOptions
 
 # thanks: https://stackoverflow.com/a/14728477/1441112
 class _ACEArgumentParser(argparse.ArgumentParser):

delphin/cli/process.py

@@ -57,7 +57,7 @@ def call_process(args):
 )
 parser.add_argument(
     '-o', '--options', metavar='OPTIONS', type=str, default='',
-    help='ACE options (see http://moin.delph-in.net/AceOptions)'
+    help='ACE options (see https://github.com/delph-in/docs/wiki/AceOptions)'
 )
 parser.add_argument(
     '-s', '--source', metavar='PATH',