sfischer13 · Dec 6, 2018 · Dec 6, 2018 · Dec 7, 2018 · Dec 7, 2018 · Dec 7, 2018
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -49,6 +49,11 @@ pipenv run flake8 .
 Documentation
 -------------
 
+```sh
+cd docs
+pipenv run sphinx-apidoc -f -o . ../arpa
+```
+
 ```sh
 cd docs
 pipenv run make html

diff --git a/HISTORY.md b/HISTORY.md
@@ -20,6 +20,9 @@ You should [Keep a CHANGELOG](https://keepachangelog.com/), too!
 
 ### Security
 
+[0.1.0b4](https://github.com/sfischer13/python-arpa/compare/0.1.0b3...0.1.0b4) - 2018-12-12
+-------------------------------------------------------------------------------------------
+
 [0.1.0b3](https://github.com/sfischer13/python-arpa/compare/0.1.0b2...0.1.0b3) - 2018-12-06
 -------------------------------------------------------------------------------------------
 

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -22,6 +22,7 @@ recursive-include docs *.rst
 
 recursive-include tests *
 recursive-exclude tests *.arpa
+recursive-exclude tests *.arpa.*
 
 recursive-exclude * __pycache__
 recursive-exclude * *.py[co]
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -1,12 +1,9 @@
 Python ARPA Package
 ===================
 
-[![PyPI Version](https://img.shields.io/pypi/v/arpa.svg)](https://pypi.python.org/pypi/arpa) [![Documentation Status](https://readthedocs.org/projects/arpa/badge/?version=latest)](https://arpa.readthedocs.io/en/latest/?badge=latest) [![Travis](https://img.shields.io/travis/sfischer13/python-arpa.svg)](https://travis-ci.org/sfischer13/python-arpa) [![Coverage Status](https://coveralls.io/repos/sfischer13/python-arpa/badge.svg?branch=master&service=github)](https://coveralls.io/github/sfischer13/python-arpa?branch=master)
-
 Python library for reading ARPA n-gram models.  
-It was initiated by Stefan Fischer and is developed and maintained by many others.
 
--   [Documentation](https://readthedocs.org/projects/arpa/badge/?version=latest) is available.
+-   [Documentation](https://arpa.readthedocs.io/en/latest/) is available.
 -   [Changes](https://github.com/sfischer13/python-arpa/blob/master/HISTORY.md) between releases are documented.
 -   [Bugs](https://github.com/sfischer13/python-arpa/issues) can be reported on the issue tracker.
 -   [Questions](mailto:sfischer13@ymail.com) can be asked via e-mail.
@@ -15,18 +12,31 @@ It was initiated by Stefan Fischer and is developed and maintained by many other
 Setup
 -----
 
-[![PyPI Python Versions](https://img.shields.io/pypi/pyversions/arpa.svg)](https://pypi.python.org/pypi/arpa)
+### Python 3.4+
+
+[![PyPI Python Versions](https://img.shields.io/pypi/pyversions/arpa.svg)](https://pypi.python.org/pypi/arpa) [![PyPI Version](https://img.shields.io/pypi/v/arpa.svg)](https://pypi.python.org/pypi/arpa)
+
+In order to install the Python 3 version:
+
+    $ pip install --user -U arpa
 
-The package is available on [PyPI](https://pypi.python.org/pypi/arpa):
+### Python 2.7
 
-    $ pip install arpa
+[![PyPI Python Versions](https://img.shields.io/pypi/pyversions/arpa-backport.svg)](https://pypi.python.org/pypi/arpa-backport) [![PyPI Version](https://img.shields.io/pypi/v/arpa-backport.svg)](https://pypi.python.org/pypi/arpa-backport)
+
+In order to install the Python 2.7 version:
+
+    $ pip install --user -U arpa-backport
 
 Usage
 -----
 
 The package may be imported directly:
 
-    import arpa
+    import arpa  # Python 3.4+
+    # OR
+    import arpa_backport as arpa  # Python 2.7
+
     models = arpa.loadf("foo.arpa")
     lm = models[0]  # ARPA files may contain several models.
 
@@ -42,9 +52,12 @@ The package may be imported directly:
     lm.s("This is the end .", sos=False, eos=False)
     lm.log_s("This is the end .", sos=False, eos=False)
 
-Contribute
-----------
+Development
+-----------
+
+[![Travis](https://img.shields.io/travis/sfischer13/python-arpa.svg)](https://travis-ci.org/sfischer13/python-arpa) [![Documentation Status](https://readthedocs.org/projects/arpa/badge/?version=latest)](https://arpa.readthedocs.io/en/latest/?badge=latest) [![Coverage Status](https://coveralls.io/repos/sfischer13/python-arpa/badge.svg?branch=master&service=github)](https://coveralls.io/github/sfischer13/python-arpa?branch=master)
 
+*Contributions are welcome!*  
 Write a bug report or send a pull request.  
 Other [contributors](https://github.com/sfischer13/python-arpa/graphs/contributors) have done so before.
 

diff --git a/arpa/__init__.py b/arpa/__init__.py
@@ -41,8 +41,8 @@
 __author__ = 'Stefan Fischer'
 __contact__ = 'Stefan Fischer <sfischer13@ymail.com>'
 __copyright__ = 'Copyright (c) 2015-2018 Stefan Fischer'
-__credits__ = []
-__date__ = '2018-12-06'
+__credits__ = ['Stefan Fischer']
+__date__ = '2018-12-12'
 __license__ = 'MIT'
 __status__ = 'development'
-__version__ = '0.1.0b3'
+__version__ = '0.1.0b4'
diff --git a/arpa/api.py b/arpa/api.py
@@ -1,3 +1,5 @@
+import gzip
+
 from io import StringIO
 
 from .models.simple import ARPAModelSimple
@@ -9,10 +11,15 @@ def dump(obj, fp):
     obj.write(fp)
 
 
-def dumpf(obj, path, mode='wt', encoding=None):
-    """Serialize obj to path in ARPA format."""
-    with open(path, mode=mode, encoding=encoding) as f:
-        dump(obj, f)
+def dumpf(obj, path, encoding=None):
+    """Serialize obj to path in ARPA format (.arpa, .gz)."""
+    path = str(path)
+    if path.endswith('.gz'):
+        with gzip.open(path, mode='wt', encoding=encoding) as f:
+            return dump(obj, f)
+    else:
+        with open(path, mode='wt', encoding=encoding) as f:
+            dump(obj, f)
 
 
 def dumps(obj):
@@ -40,10 +47,15 @@ def load(fp, model=None, parser=None):
         raise ValueError
 
 
-def loadf(path, mode='rt', encoding=None, model=None, parser=None):
-    """Deserialize path (a text file) to a Python object."""
-    with open(path, mode=mode, encoding=encoding) as f:
-        return load(f, model=model, parser=parser)
+def loadf(path, encoding=None, model=None, parser=None):
+    """Deserialize path (.arpa, .gz) to a Python object."""
+    path = str(path)
+    if path.endswith('.gz'):
+        with gzip.open(path, mode='rt', encoding=encoding) as f:
+            return load(f, model=model, parser=parser)
+    else:
+        with open(path, mode='rt', encoding=encoding) as f:
+            return load(f, model=model, parser=parser)
 
 
 def loads(s, model=None, parser=None):

diff --git a/arpa/exceptions.py b/arpa/exceptions.py
@@ -7,6 +7,12 @@ class ARPAException(Exception):
     pass
 
 
+class FatalException(ARPAException):
+    """This should not have happened."""
+
+    pass
+
+
 class FrozenException(ARPAException):
     """Language model is frozen."""
 

diff --git a/arpa/models/simple.py b/arpa/models/simple.py
@@ -24,10 +24,9 @@ def add_count(self, order, count):
     def add_entry(self, ngram, p, bo=None, order=None):
         if self._vocabulary is not None:
             raise FrozenException
-        key = tuple(ngram)
-        self._ps[key] = p
+        self._ps[ngram] = p
         if bo is not None:
-            self._bos[key] = bo
+            self._bos[ngram] = bo
 
     def counts(self):
         return sorted(self._counts.items())

diff --git a/arpa/parsers/quick.py b/arpa/parsers/quick.py
@@ -64,7 +64,7 @@ def _header(self, line):
         match = self.re_header.match(line)
         if match:
             self._state = self.State.ENTRY
-            self._tmp_order = match.group(1)
+            self._tmp_order = int(match.group(1))
         elif line == '\\end\\':
             self._result.append(self._tmp_model)
             self._state = self.State.DATA
@@ -80,8 +80,8 @@ def _entry(self, line):
         if match:
             p = self._float_or_int(match.group(1))
             ngram = tuple(match.group(4).split(' '))
-            bo = match.group(7)
-            bo = self._float_or_int(bo) if bo else None
+            bo_match = match.group(7)
+            bo = self._float_or_int(bo_match) if bo_match else None
             self._tmp_model.add_entry(ngram, p, bo, self._tmp_order)
         elif not line:
             self._state = self.State.HEADER  # last entry

diff --git a/docs/api.rst b/docs/api.rst
diff --git a/docs/arpa.models.rst b/docs/arpa.models.rst
@@ -0,0 +1,30 @@
+arpa.models package
+===================
+
+Submodules
+----------
+
+arpa.models.base module
+-----------------------
+
+.. automodule:: arpa.models.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+arpa.models.simple module
+-------------------------
+
+.. automodule:: arpa.models.simple
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: arpa.models
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/arpa.parsers.rst b/docs/arpa.parsers.rst
@@ -0,0 +1,30 @@
+arpa.parsers package
+====================
+
+Submodules
+----------
+
+arpa.parsers.base module
+------------------------
+
+.. automodule:: arpa.parsers.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+arpa.parsers.quick module
+-------------------------
+
+.. automodule:: arpa.parsers.quick
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: arpa.parsers
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/arpa.rst b/docs/arpa.rst
@@ -0,0 +1,38 @@
+arpa package
+============
+
+Subpackages
+-----------
+
+.. toctree::
+
+    arpa.models
+    arpa.parsers
+
+Submodules
+----------
+
+arpa.api module
+---------------
+
+.. automodule:: arpa.api
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+arpa.exceptions module
+----------------------
+
+.. automodule:: arpa.exceptions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: arpa
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/docs/conf.py b/docs/conf.py
@@ -25,7 +25,7 @@
 # The short X.Y version
 version = '0.1'
 # The full version, including alpha/beta/rc tags
-release = '0.1.0b3'
+release = '0.1.0b4'
 
 
 # -- General configuration ---------------------------------------------------
@@ -182,3 +182,9 @@
 
 
 # -- Extension configuration -------------------------------------------------
+
+nitpick_ignore = [
+    ('py:class', 'Exception'),
+    ('py:class', 'enum.Enum'),
+    ('py:class', 'object'),
+]
diff --git a/docs/index.rst b/docs/index.rst
@@ -3,16 +3,15 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Documentation for Python :mod:`arpa`
-====================================
+Python :mod:`arpa` package
+==========================
 
 .. toctree::
    :maxdepth: 2
-   :caption: Contents:
 
    setup
    examples
-   api
+   arpa
 
 
 Indices and tables