https://github.com/ulope/pyformat.info

Single page cheat-sheet about Python string formatting
https://github.com/ulope/pyformat.info

cheat-sheets howto python string-formatter

Last synced: about 2 months ago
JSON representation

Single page cheat-sheet about Python string formatting

• Host: GitHub
• URL: https://github.com/ulope/pyformat.info
• Owner: ulope
• License: mit
• Created: 2015-04-13T13:48:41.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2020-12-30T20:33:36.000Z (over 3 years ago)
• Last Synced: 2024-07-17T13:59:27.090Z (2 months ago)
• Topics: cheat-sheets, howto, python, string-formatter
• Language: Python
• Homepage: https://pyformat.info
• Size: 1010 KB
• Stars: 1,286
• Watchers: 59
• Forks: 138
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• starred-awesome - pyformat.info - Single page cheat-sheet about Python string formatting (Python)

README

        
# PyFormat.info: Using % and .format() for great good!

With this project @ulope and @zerok wanted to document Python's awesome string

formatting system with practical examples. While the official documentation on

python.org contains a great deal of information regarding the actual syntax

specification of the formatters and some examples, we felt it would be nice to

see the new and old style of formatting side-by-side and provide even more

practical examples.

## Version 2

We're curently working on [version 2](https://github.com/ulope/pyformat.info/tree/v2) 

of the site. This encompases a complete architecture change to use [Lektor](https://getlektor.com)

to generate the site instead of the previous homegrown approach.

The plan is currently to finish this migration in the first half of 2017.

## What is Where?

The website you can find on https://pyformat.info is statically generated using

the `main.py`. This script parses the test cases specified in

`tests/test_content.py` which is more or less where all the content of the

final site comes from.

Each test case can consist of following elements:

* A optional title which is encoded as the first line of the docstring prefixed

  with a `# `

* A short description on what is going on in the example which is what the rest

  of the docstring is used for

* A value computation for the old-style formatter which is assigned to a

  variable called `old_result`

* A value computation for the new-style formatter which is assigned to a

  variable called `new_result`

* A handful of assertions. The last one that has a string on the right side is

  used as output on the website.

* An optional setup section that is placed after the docstring and before the

  `old_result` asignment

If no `old_result` is provided this indicates that the feature is only

available for the new formatting style and an appropriate message is rendered

on the website.

## How to Contribute

If you have another awesome example of what can be done with Python's

formatters please create a new test-case in `tests/test_content.py` including a

short info message about what is going on there as the docstring.

Once you have that, simply open a pull-request! Please make sure that you code

is PEP8-compliant (except for the line length).

## Running the tests

We use [`py.test`](http://pytest.org) to both test the functionality of the script

generating the static HTML output as well as ensuring that the examples on the

page are syntactically correct and produce the desired output.

The easiest way to run the tests on all supported Python versions is by using

[`tox`](http://tox.testrun.org) for which this repository contains a configuration file.