Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

Python implementation of PVL (Parameter Value Language)

Project description

Python implementation of PVL (Parameter Value Language)

PVL is a markup language, similar to xml, commonly employed for entries in the Planetary Database System used by NASA to store mission data, among other uses. This package supports both encoding a decoding a superset of PVL, including the USGS Isis Cube Label and NASA PDS 3 Label dialects.


Can either install with pip or with conda.

To install with pip, at the command line:

$ pip install pvl

Directions for installing with conda-forge:

Installing pvl from the conda-forge channel can be achieved by adding conda-forge to your channels with:

conda config --add channels conda-forge

Once the conda-forge channel has been enabled, pvl can be installed with:

conda install pvl

It is possible to list all of the versions of pvl available on your platform with:

conda search pvl --channel conda-forge

Basic Usage

pvl exposes an API familiar to users of the standard library json module.

Decoding is primarily done through pvl.load for file like objects and pvl.loads for strings:

>>> import pvl
>>> module = pvl.loads("""
...     foo = bar
...     items = (1, 2, 3)
...     END
... """)
>>> print module
  (u'foo', u'bar')
  (u'items', [1, 2, 3])
>>> print module['foo']

You may also use pvl.load to read a label directly from an image:

>>> import pvl
>>> label = pvl.load('pattern.cub')
>>> print label
      (u'StartByte', 65537)
      (u'Format', u'Tile')
# output truncated...
>>> print label['IsisCube']['Core']['StartByte']

Similarly, encoding pvl modules is done through pvl.dump and pvl.dumps:

>>> import pvl
>>> print pvl.dumps({
...     'foo': 'bar',
...     'items': [1, 2, 3]
... })
items = (1, 2, 3)
foo = bar

PVLModule objects may also be pragmatically built up to control the order of parameters as well as duplicate keys:

>>> import pvl
>>> module = pvl.PVLModule({'foo': 'bar'})
>>> module.append('items', [1, 2, 3])
>>> print pvl.dumps(module)
foo = bar
items = (1, 2, 3)

A PVLModule is a dict like container that preserves ordering as well as allows multiple values for the same key. It provides a similar similar semantics to a list of key/value tuples but with dict style access:

>>> import pvl
>>> module = pvl.PVLModule([
...     ('foo', 'bar'),
...     ('items', [1, 2, 3]),
...     ('foo', 'remember me?'),
... ])
>>> print module['foo']
>>> print module.getlist('foo')
['bar', 'remember me?']
>>> print module.items()
[('foo', 'bar'), ('items', [1, 2, 3]), ('foo', u'remember me?')]
>>> print pvl.dumps(module)
foo = bar
items = (1, 2, 3)
foo = "remember me?"

For more information on custom serilization and deseralization see the full documentation.


Feedback, issues, and contributions are always gratefully welcomed. See the contributing guide for details on how to help and setup a development environment.


0.3.0 (2017-06-28)

  • Create methods to add items to the label
  • Give user option to allow the parser to succeed in parsing broken labels

0.2.0 (2015-08-13)

  • Drastically increase test coverage.
  • Lots of bug fixes.
  • Add Cube and PDS encoders.
  • Cleanup README.
  • Use pvl specification terminology.
  • Added element access by index and slice.

0.1.1 (2015-06-01)

  • Fixed issue with reading Pancam PDS Products.

0.1.0 (2015-05-30)

  • First release on PyPI.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pvl, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size pvl-0.3.0.tar.gz (68.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page