{"author":null,"author_email":"Taneli Hukkinen ","bugtrack_url":null,"classifiers":["License :: OSI Approved :: MIT License","Operating System :: MacOS","Operating System :: Microsoft :: Windows","Operating System :: POSIX :: Linux","Programming Language :: Python :: 3 :: Only","Programming Language :: Python :: Implementation :: CPython","Programming Language :: Python :: Implementation :: PyPy","Topic :: Software Development :: Libraries :: Python Modules","Typing :: Typed"],"description":"[![Build Status](https://github.com/hukkin/tomli-w/actions/workflows/tests.yaml/badge.svg?branch=master)](https://github.com/hukkin/tomli-w/actions?query=workflow%3ATests+branch%3Amaster+event%3Apush)\n[![codecov.io](https://codecov.io/gh/hukkin/tomli-w/branch/master/graph/badge.svg)](https://codecov.io/gh/hukkin/tomli-w)\n[![PyPI version](https://img.shields.io/pypi/v/tomli-w)](https://pypi.org/project/tomli-w)\n\n# Tomli-W\n\n> A lil' TOML writer\n\n**Table of Contents** *generated with [mdformat-toc](https://github.com/hukkin/mdformat-toc)*\n\n\n\n- [Intro](#intro)\n- [Installation](#installation)\n- [Usage](#usage)\n - [Write to string](#write-to-string)\n - [Write to file](#write-to-file)\n- [FAQ](#faq)\n - [Does Tomli-W sort the document?](#does-tomli-w-sort-the-document)\n - [Does Tomli-W support writing documents with comments?](#does-tomli-w-support-writing-documents-with-comments)\n - [Can I customize insignificant whitespace?](#can-i-customize-insignificant-whitespace)\n - [Why does Tomli-W not write a multi-line string if the string value contains newlines?](#why-does-tomli-w-not-write-a-multi-line-string-if-the-string-value-contains-newlines)\n - [Is Tomli-W output guaranteed to be valid TOML?](#is-tomli-w-output-guaranteed-to-be-valid-toml)\n\n\n\n## Intro\n\nTomli-W is a Python library for writing [TOML](https://toml.io).\nIt is a write-only counterpart to [Tomli](https://github.com/hukkin/tomli),\nwhich is a read-only TOML parser.\nTomli-W is fully compatible with [TOML v1.0.0](https://toml.io/en/v1.0.0).\n\n## Installation\n\n```bash\npip install tomli-w\n```\n\n## Usage\n\n### Write to string\n\n```python\nimport tomli_w\n\ndoc = {\"table\": {\"nested\": {}, \"val3\": 3}, \"val2\": 2, \"val1\": 1}\nexpected_toml = \"\"\"\\\nval2 = 2\nval1 = 1\n\n[table]\nval3 = 3\n\n[table.nested]\n\"\"\"\nassert tomli_w.dumps(doc) == expected_toml\n```\n\n### Write to file\n\n```python\nimport tomli_w\n\ndoc = {\"one\": 1, \"two\": 2, \"pi\": 3}\nwith open(\"path_to_file/conf.toml\", \"wb\") as f:\n tomli_w.dump(doc, f)\n```\n\n## FAQ\n\n### Does Tomli-W sort the document?\n\nNo, but it respects sort order of the input data,\nso one could sort the content of the `dict` (recursively) before calling `tomli_w.dumps`.\n\n### Does Tomli-W support writing documents with comments?\n\nNo.\n\n### Can I customize insignificant whitespace?\n\nIndent width of array content can be configured via the `indent` keyword argument.\n`indent` takes a non-negative integer, defaulting to 4.\n\n```python\nimport tomli_w\n\ndoc = {\"fruits\": [\"orange\", \"kiwi\", \"papaya\"]}\nexpected_toml = \"\"\"\\\nfruits = [\n \"orange\",\n \"kiwi\",\n \"papaya\",\n]\n\"\"\"\nassert tomli_w.dumps(doc, indent=1) == expected_toml\n```\n\n### Why does Tomli-W not write a multi-line string if the string value contains newlines?\n\nThis default was chosen to achieve lossless parse/write round-trips.\n\nTOML strings can contain newlines where exact bytes matter, e.g.\n\n```toml\ns = \"here's a newline\\r\\n\"\n```\n\nTOML strings also can contain newlines where exact byte representation is not relevant, e.g.\n\n```toml\ns = \"\"\"here's a newline\n\"\"\"\n```\n\nA parse/write round-trip that converts the former example to the latter does not preserve the original newline byte sequence.\nThis is why Tomli-W avoids writing multi-line strings.\n\nA keyword argument is provided for users who do not need newline bytes to be preserved:\n\n```python\nimport tomli_w\n\ndoc = {\"s\": \"here's a newline\\r\\n\"}\nexpected_toml = '''\\\ns = \"\"\"\nhere's a newline\n\"\"\"\n'''\nassert tomli_w.dumps(doc, multiline_strings=True) == expected_toml\n```\n\n### Is Tomli-W output guaranteed to be valid TOML?\n\nNo.\nIf there's a chance that your input data is bad and you need output validation,\nparse the output string once with `tomli.loads`.\nIf the parse is successful (does not raise `tomli.TOMLDecodeError`) then the string is valid TOML.\n\nExamples of bad input data that can lead to writing invalid TOML without an error being raised include:\n\n- A mapping where keys behave very much like strings, but aren't. E.g. a tuple of strings of length 1.\n- A mapping where a value is a subclass of a supported type, but which overrides the `__str__` method.\n\nGiven proper input (a mapping consisting of non-subclassed [types returned by Tomli](https://github.com/hukkin/tomli?tab=readme-ov-file#how-do-toml-types-map-into-python-types))\nthe output should be valid TOML.\n\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":null,"home_page":null,"keywords":"toml, tomli","license":null,"license_expression":null,"license_files":null,"maintainer":null,"maintainer_email":null,"name":"tomli-w","package_url":"https://pypi.org/project/tomli-w/","platform":null,"project_url":"https://pypi.org/project/tomli-w/","project_urls":{"Changelog":"https://github.com/hukkin/tomli-w/blob/master/CHANGELOG.md","Homepage":"https://github.com/hukkin/tomli-w"},"provides_extra":null,"release_url":"https://pypi.org/project/tomli-w/1.2.0/","requires_dist":null,"requires_python":">=3.9","summary":"A lil' TOML writer","version":"1.2.0","yanked":false,"yanked_reason":null}

Package search

tomli-w

project_urls

Dependencies

All package metadata

Releases