Upgrade to main branch

.github/workflows/lint.yml

@@ -9,12 +9,12 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.12']
+        python-version: ['3.13']
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

.github/workflows/tabulate.yml

@@ -3,26 +3,35 @@ name: pytest
 on:
   - push
   - pull_request
+  - workflow_dispatch
 
 jobs:
   build:
     strategy:
       matrix:
-        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13']
+        python-version: ['3.10', '3.11', '3.12', '3.13', '3.14']
         os: ["ubuntu-latest", "windows-latest", "macos-latest"]
     runs-on: ${{ matrix.os }}
 
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v6
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: ${{ matrix.python-version }}
         allow-prereleases: true
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install pytest numpy pandas
+        python -m pip install pytest pytest-cov numpy pandas "wcwidth>=0.6.0"
     - name: Run tests
       run: |
-        pytest -v --doctest-modules --ignore benchmark/benchmark.py
+        pytest -v --doctest-modules --ignore benchmark --doctest-glob="README.md" --cov=tabulate --cov-branch --cov-report=xml
+    - name: Upload coverage reports to Codecov
+      uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true

.gitignore

@@ -1,4 +1,4 @@
-/tabulate/version.py
+/tabulate/_version.py
 
 build
 dist
@@ -19,3 +19,4 @@ website-build/
 ## Unit test / coverage reports
 .coverage
 .tox
+/tabulate/_version.py

.pre-commit-config.yaml

@@ -1,15 +1,13 @@
 repos:
--   repo: https://github.com/python/black
-    rev: 22.3.0
+-   repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.4
     hooks:
-    -   id: black
-        args: [--safe]
-        language_version: python3
+    -   id: ruff-check
+        args: ["--fix", "--show-fixes"]
+    -   id: ruff-format
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.2.3
+    rev: v6.0.0
     hooks:
+    -   id: end-of-file-fixer
     -   id: trailing-whitespace
     -   id: check-yaml
-    -   id: debug-statements
-    -   id: flake8
-        language_version: python3

CHANGELOG

@@ -1,5 +1,12 @@
-- 0.10.0: Add support for Python 3.11, 3.12, 3.13.
-  Drop support for Python 3.7, 3.8.
+- 0.11.0:
+  Drop support of the legacy `youtrack` format.
+  Add support of the `Decimal` data type.
+  Improve output of `github` and `asciidoc` formats.
+  Add support of CSV and JSONL input data in CLI utility.
+  Always add `text-align: left` in HTML output.
+  Various bug fixes.
+- 0.10.0: Add support for Python 3.11, 3.12, 3.13, 3.14.
+  Drop support for Python 3.7, 3.8, 3.9.
   PRESERVE_STERILITY global is replaced with preserve_sterility function argument.
   New formatting options: headersglobalalign, headersalign, colglobalalign.
   New output format: ``colon_grid`` (Pandoc grid_tables with alignment)

HOWTOPUBLISH

@@ -1,15 +1,17 @@
 # update contributors and CHANGELOG in README
 python -m pre_commit run -a # and then commit changes
-tox -e py39-extra,py310-extra,py311-extra,py312-extra,py313-extra
-# tag version release
-python -m build -s # this will update tabulate/version.py
+tox -e py310-extra,py311-extra,py312-extra,py313-extra,py314-extra
+# tag version release (vX.Y.Z)
+python -m pip install build twine
+python -m build -s # this will update tabulate/_version.py
 python -m pip install . # install tabulate in the current venv
 python -m pip install -r benchmark/requirements.txt
 python benchmark/benchmark.py  # then update README
 # move tag to the last commit
-python -m build -s # update tabulate/version.py
+python -m build -s # update tabulate/_version.py
 python -m build -nswx .
 git push # wait for all CI builds to succeed
 git push --tags # if CI builds succeed
 twine upload --repository-url https://test.pypi.org/legacy/ dist/*
 twine upload dist/*
+# use __token__ as username andPyPI API token as password (generate at pypi.org → Account settings → API tokens)

README.md

@@ -53,7 +53,7 @@ pip install tabulate
 Build status
 ------------
 
-[![python-tabulate](https://github.com/astanin/python-tabulate/actions/workflows/tabulate.yml/badge.svg)](https://github.com/astanin/python-tabulate/actions/workflows/tabulate.yml)
+[![python-tabulate](https://github.com/astanin/python-tabulate/actions/workflows/tabulate.yml/badge.svg)](https://github.com/astanin/python-tabulate/actions/workflows/tabulate.yml) [![codecov](https://codecov.io/github/astanin/python-tabulate/graph/badge.svg?token=Aa6wexP5wq)](https://codecov.io/github/astanin/python-tabulate)
 
 Library usage
 -------------
@@ -196,7 +196,6 @@ Supported table formats are:
 -   "rst"
 -   "mediawiki"
 -   "moinmoin"
--   "youtrack"
 -   "html"
 -   "unsafehtml"
 -   "latex"
@@ -234,12 +233,12 @@ bacon       0
 ```
 
 `github` follows the conventions of GitHub flavored Markdown. It
-corresponds to the `pipe` format without alignment colons:
+corresponds to the `pipe` format with the same alignment colons:
 
 ```pycon
 >>> print(tabulate(table, headers, tablefmt="github"))
 | item   |   qty |
-|--------|-------|
+|:-------|------:|
 | spam   |    42 |
 | eggs   |   451 |
 | bacon  |     0 |
@@ -501,12 +500,12 @@ format:
 
 ```pycon
 >>> print(tabulate(table, headers, tablefmt="asciidoc"))
-[cols="8<,7>",options="header"]
+[cols="<8,>7",options="header"]
 |====
-| item   |   qty 
-| spam   |    42 
-| eggs   |   451 
-| bacon  |     0 
+| item   |   qty
+| spam   |    42
+| eggs   |   451
+| bacon  |     0
 |====
 
 ```
@@ -577,21 +576,10 @@ MediaWiki-based sites:
 
 ```pycon
 >>> print(tabulate(table, headers, tablefmt="moinmoin"))
-|| ''' item   ''' ||<style="text-align: right;"> '''   qty ''' ||
-||  spam    ||<style="text-align: right;">     42  ||
-||  eggs    ||<style="text-align: right;">    451  ||
-||  bacon   ||<style="text-align: right;">      0  ||
-
-```
-
-`youtrack` format produces a table markup used in Youtrack tickets:
-
-```pycon
->>> print(tabulate(table, headers, tablefmt="youtrack"))
-||  item    ||    qty  ||
-|  spam    |     42  |
-|  eggs    |    451  |
-|  bacon   |      0  |
+||<style="text-align: left;"> ''' item   ''' ||<style="text-align: right;"> '''   qty ''' ||
+||<style="text-align: left;">  spam    ||<style="text-align: right;">     42  ||
+||<style="text-align: left;">  eggs    ||<style="text-align: right;">    451  ||
+||<style="text-align: left;">  bacon   ||<style="text-align: right;">      0  ||
 
 ```
 
@@ -616,12 +604,12 @@ and a .str property so that the raw HTML remains accessible.
 >>> print(tabulate(table, headers, tablefmt="html"))
 <table>
 <thead>
-<tr><th>item  </th><th style="text-align: right;">  qty</th></tr>
+<tr><th style="text-align: left;">item  </th><th style="text-align: right;">  qty</th></tr>
 </thead>
 <tbody>
-<tr><td>spam  </td><td style="text-align: right;">   42</td></tr>
-<tr><td>eggs  </td><td style="text-align: right;">  451</td></tr>
-<tr><td>bacon </td><td style="text-align: right;">    0</td></tr>
+<tr><td style="text-align: left;">spam  </td><td style="text-align: right;">   42</td></tr>
+<tr><td style="text-align: left;">eggs  </td><td style="text-align: right;">  451</td></tr>
+<tr><td style="text-align: left;">bacon </td><td style="text-align: right;">    0</td></tr>
 </tbody>
 </table>
 
@@ -819,7 +807,7 @@ methods `__str__` and `__float__` defined (and hence is convertible to a
 `float` and also has a `str` representation), the appropriate
 representation is selected for the column's deduced type.  In order to not
 lose precision accidentally, types having both an `__int__` and
-`__float__` represention will be considered a `float`.
+`__float__` representation will be considered a `float`.
 
 Therefore, if your table contains types convertible to int/float but you'd
 *prefer* they be represented as strings, or your strings *might* all look
@@ -1063,6 +1051,36 @@ the lines being wrapped would probably be significantly longer than this.
 
 ```
 
+Text is preferably wrapped on whitespaces and right after the hyphens in hyphenated words.
+
+break_long_words (default: True)  If true, then words longer than width will be broken in order to ensure that no lines are longer than width.
+If it is false, long words will not be broken, and some lines may be longer than width.
+(Long words will be put on a line by themselves, in order to minimize the amount by which width is exceeded.)
+
+break_on_hyphens (default: True) If true, wrapping will occur preferably on whitespaces and right after hyphens in compound words, as it is customary in English.
+If false, only whitespaces will be considered as potentially good places for line breaks.
+
+```pycon
+>>> print(tabulate([["John Smith", "Middle-Manager"]], headers=["Name", "Title"], tablefmt="grid", maxcolwidths=[None, 5], break_long_words=False))
++------------+---------+
+| Name       | Title   |
++============+=========+
+| John Smith | Middle- |
+|            | Manager |
++------------+---------+
+
+```
+
+```pycon
+>>> print(tabulate([["John Smith", "Middle-Manager"]], headers=["Name", "Title"], tablefmt="grid", maxcolwidths=[None, 5], break_long_words=False, break_on_hyphens=False))
++------------+----------------+
+| Name       | Title          |
++============+================+
+| John Smith | Middle-Manager |
++------------+----------------+
+
+```
+
 ### Adding Separating lines
 One might want to add one or more separating lines to highlight different sections in a table.
 
@@ -1098,7 +1116,7 @@ table, however, ANSI escape sequences are not removed so the original styling is
 
 Some terminals support a special grouping of ANSI escape sequences that are intended to display hyperlinks
 much in the same way they are shown in browsers. These are handled just as mentioned before: non-printable
-ANSI escape sequences are removed prior to string length calculation. The only diifference with escaped
+ANSI escape sequences are removed prior to string length calculation. The only difference with escaped
 hyperlinks is that column width will be based on the length of the URL _text_ rather than the URL
 itself (terminals would show this text). For example:
 
@@ -1109,24 +1127,46 @@ itself (terminals would show this text). For example:
 Usage of the command line utility
 ---------------------------------
 
-    Usage: tabulate [options] [FILE ...]
-
-    FILE                      a filename of the file with tabular data;
-                              if "-" or missing, read data from stdin.
-
-    Options:
-
-    -h, --help                show this message
-    -1, --header              use the first row of data as a table header
-    -o FILE, --output FILE    print table to FILE (default: stdout)
-    -s REGEXP, --sep REGEXP   use a custom column separator (default: whitespace)
-    -F FPFMT, --float FPFMT   floating point number format (default: g)
-    -I INTFMT, --int INTFMT   integer point number format (default: "")
-    -f FMT, --format FMT      set output table format; supported formats:
-                              plain, simple, github, grid, fancy_grid, pipe,
-                              orgtbl, rst, mediawiki, html, latex, latex_raw,
-                              latex_booktabs, latex_longtable, tsv
-                              (default: simple)
+```
+Usage: tabulate [options] [FILE ...]
+
+Pretty-print tabular data. Use Python module for more features.
+
+FILE                      a filename of the file with tabular data;
+                          if "-" or missing, read data from stdin.
+
+Options:
+
+-h, --help                show this message
+
+INPUT:
+-r, --read FILEFORMAT     parse input FILEs as:
+                          rsv (REGEXP-separated values, default),
+                          csv (comma-separated valued, Excel dialect),
+                          jsonl (one JSON object per line)
+-s REGEXP, --sep REGEXP   column separator for rsv data (default: whitespace)
+
+FORMAT:
+--headers HEADERS         HEADERS can be one of:
+                          "firstrow" (for csv and rsv data),
+                          "keys" (for jsonl data),
+                          "HEADER1,HEADER2,..." (for csv and rsv data),
+                          "KEY1:HEADER1,KEY2:HEADER2,..." (for jsonl data)
+-1                        use the first row of input data as a table header
+                          (the same as --headers firstrow)
+-F FPFMT, --float FPFMT   floating point number format (default: g)
+-I INTFMT, --int INTFMT   integer point number format (default: "")
+-f FMT, --format FMT      set output table format (default: simple)
+
+Supported output formats: asciidoc, colon_grid, double_grid, double_outline,
+fancy_grid, fancy_outline, github, grid, heavy_grid, heavy_outline, html, jira,
+latex, latex_booktabs, latex_longtable, latex_raw, mediawiki, mixed_grid, mixed_outline,
+moinmoin, orgtbl, outline, pipe, plain, presto, pretty, psql, rounded_grid,
+rounded_outline, rst, simple, simple_grid, simple_outline, textile, tsv, unsafehtml.
+
+OUTPUT:
+-o FILE, --output FILE    print table to FILE (default: stdout)
+```
 
 Performance considerations
 --------------------------
@@ -1147,17 +1187,17 @@ simply joining lists of values with a tab, comma, or other separator.
 At the same time, `tabulate` is comparable to other table
 pretty-printers. Given a 10x10 table (a list of lists) of mixed text and
 numeric data, `tabulate` appears to be faster than `PrettyTable` and `texttable`.
-The following mini-benchmark was run in Python 3.11.9 on Windows 11 (x64):
+The following mini-benchmark was run in Python 3.13.7 on Windows 11 (x64):
 
     ==================================  ==========  ===========
     Table formatter                       time, μs    rel. time
     ==================================  ==========  ===========
-    join with tabs and newlines                6.3          1.0
-    csv to StringIO                            6.6          1.0
-    tabulate (0.10.0)                        249.2         39.3
-    tabulate (0.10.0, WIDE_CHARS_MODE)       325.6         51.4
-    texttable (1.7.0)                        579.3         91.5
-    PrettyTable (3.11.0)                     605.5         95.6
+    csv to StringIO                           11.9          1.0
+    join with tabs and newlines               12.1          1.0
+    PrettyTable (3.17.0)                     468.0         39.3
+    tabulate (0.10.0)                        553.4         46.5
+    tabulate (0.10.0, WIDE_CHARS_MODE)       612.2         51.4
+    texttable (1.7.0)                       1071.4         90.0
     ==================================  ==========  ===========
 
 
@@ -1254,4 +1294,6 @@ Vijaya Krishna Kasula, Furcy Pin, Christian Fibich, Shaun Duncan,
 Dimitri Papadopoulos, Élie Goudout, Racerroar888, Phill Zarfos,
 Keyacom, Andrew Coffey, Arpit Jain, Israel Roldan, ilya112358,
 Dan Nicholson, Frederik Scheerer, cdar07 (cdar), Racerroar888,
-Perry Kundert.
+Perry Kundert, Hnasar, Jun Koo, Jo2234, Bjorn Olsen, George Schizas,
+Kadir Can Ozden, Jeff Quast, Mayukha Vadari, Rebecca Jean Herman,
+Ján Jančár (J08nY).