Skip to main content

A parser for molecule formula. Nested brackets are supported.

Project description

pymolecule-parser: A parser for a molecule formula that supports nested brackets

pymolecule-parser-test

Installation

pip install pymolecule-parser

Usage

  • pymolecule_parser.parse returns a dictionary of atoms and their numbers. (type: dict[str, int])
from pymolecule_parser import parse

dict_1 = parse("H2O") # {'H': 2, 'O': 1}
dict_2 = parse("3H2O") # {'H': 6, 'O': 3}
dict_3 = parse("H2O2(OH)2") # {'H': 4, 'O': 4}
dict_4 = parse("[Co(NH3)6]Cl3") # {'Co': 1, 'N': 6, 'H': 18, 'Cl': 3}

Options

  • strict_mode
    • If strict_mode is True, the parser expects all atoms in the argument to be from hydrogen (H) to oganeson (Og), otherwise raises an exception
    • If strict_mode is False, the parser parses arguments even if they are not existing atoms if they satisfy the rules for writing atoms (first letter is uppercase, subsequent letters are lowercase)
    • Default: False (non-strict mode)

If you want to use strict mode, please use the following code.

from pymolecule_parser import parse

dict_1 = parse("H2O", strict_mode=True) # {'H': 2, 'O': 1}

Limitations

The following notations are not supported.

  • Ion notations
    • For example, [Cu(NH3)4]2+ is not supported. Use Cu(NH3)4 instead.
  • middle dot ·
    • For example, CuSO4·5H2O is not supported. Use CuSO4(H2O)5 instead.

License

Apache License 2.0

Author

Kohei Noda

Project details


Download files

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

Source Distribution

pymolecule_parser-0.1.0.tar.gz (12.7 kB view hashes)

Uploaded Source

Built Distribution

pymolecule_parser-0.1.0-py3-none-any.whl (9.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page