Update ASV instructions, results, and pin setuptools in asv config

.pre-commit-config.yaml

@@ -1,5 +1,6 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
+exclude: benchmarks/
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.0.1

asv.conf.json

@@ -29,6 +29,6 @@
     "3.10"
   ],
   "matrix": {
-    "req": {}
+    "setuptools": ["59.2.0"]
   }
 }

asvhashfile

@@ -0,0 +1,22 @@
+v10.0.0
+v10.2.2
+v10.6.0
+v10.7.0
+v10.8.0
+v10.9.0
+v11.0.0
+v11.1.0
+v11.2.0
+v12.0.0
+v12.0.1
+v12.1.0
+v12.2.0
+v12.3.0
+v12.4.0
+v12.4.1
+v12.4.2
+v12.4.3
+v12.4.4
+v8.0.0
+v9.13.0
+v9.5.1

benchmarks/README.md

@@ -2,6 +2,8 @@
 
 This directory contains benchmarks, for monitoring the performance of Rich over time.
 
+View the benchmark dashboard [here](https://textualize.github.io/rich-benchmarks/).
+
 The benchmarks use a tool called [Airspeed Velocity](https://asv.readthedocs.io/en/stable) (`asv`),
 and we've configured it in [asv.conf.json](../asv.conf.json).
 
@@ -15,3 +17,13 @@ here are some common actions:
 * To generate a static website for browsing the results, run `asv publish`. The resulting HTML can be found in `benchmarks/html`.
 
 The asv docs have some more examples [here](https://asv.readthedocs.io/en/stable/using.html#benchmarking).
+
+## Updating the Benchmark Website
+
+1. Ensure any tags you wish to benchmark are included in the file `asvhashfile` at the root of the repo.
+2. Run the benchmarks for those tags by running `asv run HASHFILE:asvhashfile`. This will take several minutes.
+3. Create the HTML locally for those benchmarks by running `asv publish`.
+4. Run `asv preview` to launch a local webserver that will let you preview the benchmarks dashboard. Navigate to the URL this command gives you and check everything looks fine.
+5. Checkout the `rich-benchmarks` repo from [here](https://github.com/Textualize/rich-benchmarks) and `cd` into it.
+6. Copy the HTML you generated earlier into the root of this repo, e.g. `cp -r ../rich/benchmarks/html/* .` (assuming you checked out `rich-benchmarks` alongside `rich` in your filesystem)
+7. When the HTML is merged into `main`, the [benchmark dashboard](https://textualize.github.io/rich-benchmarks/) will be updated automatically via a GitHub Action.

benchmarks/results/darrenburns-2022-mbp/03392a1b-virtualenv-py3.10-setuptools59.2.0.json

@@ -0,0 +1 @@
+{"commit_hash": "03392a1bf51296b52f1184a1adfeb3bcc5964537", "env_name": "virtualenv-py3.10-setuptools59.2.0", "date": 1646756778000, "params": {"arch": "arm64", "cpu": "Apple M1 Pro", "machine": "darrenburns-2022-mbp", "num_cpu": "10", "os": "Darwin 21.2.0", "ram": "17179869184", "python": "3.10", "setuptools": "59.2.0"}, "python": "3.10", "requirements": {"setuptools": "59.2.0"}, "env_vars": {}, "result_columns": ["result", "params", "version", "started_at", "duration", "stats_ci_99_a", "stats_ci_99_b", "stats_q_25", "stats_q_75", "stats_number", "stats_repeat", "samples", "profile"], "results": {"benchmarks.ColorSuite.time_downgrade_to_eight_bit": [[1.738586932037403e-07], [], "9da5ad0b5cfed4def0fe21fbea49ad4605f84bae78c584d9178a6b21be58d506", 1655825783382, 0.45367, [1.7009e-07], [1.7675e-07], [1.7297e-07], [1.7427e-07], [64374], [10]], "benchmarks.ColorSuite.time_downgrade_to_standard": [[1.723085623473925e-07], [], "431bf40cae6650c65cdc6da70528f559c2e902abe9370cb73780dac5b5ef6826", 1655825783609, 0.45987, [1.7069e-07], [1.7519e-07], [1.7169e-07], [1.7336e-07], [64185], [10]], "benchmarks.ColorSuite.time_downgrade_to_windows": [[1.7191213146343672e-07], [], "fef8d3fdb69ece95d49b5637f9d69760e29819d2d6e65e53e62356fec2e11b91", 1655825783842, 0.4471, [1.7078e-07], [1.755e-07], [1.7147e-07], [1.7305e-07], [64111], [10]], "benchmarks.ColorSuiteCached.time_downgrade_to_eight_bit": [[1.7480414383113038e-07], [], "5fdae4522a081f8212ac2d43d69bbc86b73876c4222f6ea36a80970afe663579", 1655825784065, 0.47098, [1.7336e-07], [1.7963e-07], [1.7436e-07], [1.7763e-07], [64501], [10]], "benchmarks.ColorSuiteCached.time_downgrade_to_standard": [[1.7323096606325328e-07], [], "3806eb6f32fcfc22ff57b23b1d09e25fc82c35a97183e285d257fb2e2b464f8f", 1655825784299, 0.4486, [1.7026e-07], [1.7473e-07], [1.7195e-07], [1.7422e-07], [59225], [10]], "benchmarks.ColorSuiteCached.time_downgrade_to_windows": [[1.7212217185985377e-07], [], "2844899e3d81f71bd0b997401e1d300394b3ca130a056eb6b9aaca15ef07f39d", 1655825784519, 0.46225, [1.7095e-07], [1.7441e-07], [1.7182e-07], [1.7394e-07], [64732], [10]], "benchmarks.PrettySuite.time_pretty": [[0.0011315717905138931], [], "12ef039b78ab19f0024f810fc30791bfe497731139b30a8c8ea7aef36ef9fed2", 1655825784753, 0.44776, [0.0011214], [0.0011467], [0.0011244], [0.0011402], [9], [10]], "benchmarks.PrettySuite.time_pretty_indent_guides": [[0.001592616001809282], [], "27d39951a834104a09759cd0c9b1efe8570946400d606a04baad7b0e2355a259", 1655825784975, 0.4537, [0.0015711], [0.0016068], [0.0015899], [0.0015957], [7], [10]], "benchmarks.PrettySuite.time_pretty_justify_center": [[0.0014231197419576347], [], "51fe6d435fa7bcd605b26131da960edffb88929baa7aca98c9b3f7b23364cb6f", 1655825785199, 0.47133, [0.0014165], [0.0014553], [0.0014203], [0.0014331], [8], [10]], "benchmarks.StyleSuite.time_parse_ansi": [[1.146300390136868e-07], [], "30751ae63d82770f620ab5f807faf7437a5a7f2309db0c6403adb23ce9571ee5", 1655825785428, 0.46149, [1.1435e-07], [1.1584e-07], [1.1451e-07], [1.1561e-07], [96121], [10]], "benchmarks.StyleSuite.time_parse_hex": [[1.1486444436295733e-07], [], "4d64f24e35306bc59f161cfd8e9542f1f76521ac58951af3841fba1722a9917b", 1655825785663, 0.4626, [1.1443e-07], [1.1541e-07], [1.1472e-07], [1.1502e-07], [93121], [10]], "benchmarks.StyleSuite.time_parse_mixed_complex_style": [[1.1674455186399795e-07], [], "9a9eff6e02c4c05312809b98da8d740a48c93f8718ff7ba74cfec9e3f956dbd8", 1655825785895, 0.45923, [1.1638e-07], [1.1853e-07], [1.1646e-07], [1.1687e-07], [90627], [10]], "benchmarks.SyntaxWrappingSuite.time_text_thin_terminal_heavy_wrapping": [[0.008622604247648269], [], "bcf6771787d6f643c3a02ed76b9045b8c773101dd7d307f989596e535a1dc8fa", 1655825786120, 0.52476, [0.0083983], [0.008688], [0.0085029], [0.0086519], [2], [10]], "benchmarks.SyntaxWrappingSuite.time_text_thin_terminal_medium_wrapping": [[0.00847084348788485], [], "df349deebd0cb3fe2602808efb2cc95270bdd3ff3734e07c13348039c5385ff9", 1655825786383, 0.52402, [0.008408], [0.0088033], [0.0084445], [0.0085167], [2], [10]], "benchmarks.SyntaxWrappingSuite.time_text_wide_terminal_no_wrapping": [[0.008550531463697553], [], "0af0a4fdbcad1978765c9980b246270adec7d7917b7fb7ce9f544a55892503c2", 1655825786646, 0.52076, [0.0084579], [0.0086286], [0.008481], [0.0085728], [2], [10]], "benchmarks.TableSuite.time_table_heavy_wrapping": [[0.0019143819226883352], [], "ca515a9739c1e0f8eb922420f9f9caf27321fb13c8bd0bc49b207a0588b370de", 1655825786907, 0.45865, [0.0018906], [0.0019471], [0.0019011], [0.0019205], [6], [10]], "benchmarks.TableSuite.time_table_no_wrapping": [[0.0011872199441616733], [], "8842a5f141d8208ba2bab66e4973e978cb5d0615f326af5d70385ff8fa44b3b9", 1655825787137, 0.45435, [0.0011653], [0.0012711], [0.0011818], [0.0012011], [9], [10]], "benchmarks.TextSuite.time_align_center": [[0.00038607810607313046], [], "f51eebb0dd72719da589ba30bbd85be25adf556231f15da3b8694499bb5b124f", 1655825787366, 0.4641, [0.00038143], [0.0003936], [0.00038216], [0.00038999], [28], [10]], "benchmarks.TextSuite.time_align_center_unicode_heavy": [[0.0003416095447215823], [], "6f157a0bd86b9db1c709c8fa9716458f797106b55ecd35afab408bd281b27e40", 1655825787600, 0.44888, [0.00033924], [0.00035135], [0.00034021], [0.00034544], [31], [10]], "benchmarks.TextSuite.time_divide": [[2.5654608274207393e-05], [], "64851da7a4fff5f7eedf5d6f18883aeb59a43decf556c31e627b6973bd1cc34e", 1655825787829, 0.45379, [2.549e-05], [2.6352e-05], [2.5573e-05], [2.5977e-05], [425], [10]], "benchmarks.TextSuite.time_divide_unicode_heavy": [[0.00018742816434402402], [], "703b70a87fe0aa1599bb2e397e436f2387baf8cf7dcf349952df217899b97097", 1655825788061, 0.46248, [0.00018461], [0.0001897], [0.00018535], [0.0001896], [58], [10]], "benchmarks.TextSuite.time_fit": [[4.4319670277870134e-05], [], "8eab5a31717088de197d2d9f60d4e1658dbf3941e1afc4a378134fc8683c8bef", 1655825788292, 0.45522, [4.4177e-05], [4.48e-05], [4.4262e-05], [4.4388e-05], [247], [10]], "benchmarks.TextSuite.time_fit_unicode_heavy": [[0.0003343661647346435], [], "7154022579acd99d94691787cdf31162b15e38998dbc46d85250baacfdb339ef", 1655825788523, 0.46974, [0.00033042], [0.00033629], [0.00033348], [0.00033466], [33], [10]], "benchmarks.TextSuite.time_indent_guides": [[0.00036045115698000476], [], "5a3722c26c96d1ef013e493ae4d2f99aa04f989ae6a8229123afd9d80f38a384", 1655825788757, 0.45264, [0.00035544], [0.00036954], [0.00035639], [0.00036479], [29], [10]], "benchmarks.TextSuite.time_render": [[4.6998019517272645e-06], [], "28f30de133a59a0ae0c7e34075766a5a7e492acb6401c8ceb24b6d0c4002db53", 1655825788982, 0.45762, [4.6888e-06], [4.8101e-06], [4.6936e-06], [4.759e-06], [2315], [10]], "benchmarks.TextSuite.time_render_unicode_heavy": [[8.597965792232141e-05], [], "71f96ca5c6fe650b498a68a82f7268a1cd3d4b003a01d620fa0456b0827311e2", 1655825789217, 0.46523, [8.5302e-05], [8.8217e-05], [8.5555e-05], [8.7521e-05], [127], [10]], "benchmarks.TextSuite.time_split": [[3.587506696215418e-05], [], "8ced6624e81ea79c121959a499bd08a83578f32be271fce55bad42196ba221b7", 1655825789451, 0.45929, [3.5783e-05], [3.6182e-05], [3.584e-05], [3.5921e-05], [305], [10]], "benchmarks.TextSuite.time_split_unicode_heavy": [[0.0002828251055784916], [], "edcdec63428ba276875d287976df2ef6ea68e66a44dfe252a80eecd7705aa47d", 1655825789684, 0.45846, [0.00028009], [0.00028469], [0.00028076], [0.00028337], [38], [10]], "benchmarks.TextSuite.time_wrapping": [[0.0014092838682699949], [], "7ee504db351412170e9e040a3c5f76a06ceb92b020dfd04c3d0ce3f2b7f5bc58", 1655825789914, 0.45332, [0.0013994], [0.0014623], [0.0014072], [0.0014124], [8], [10]], "benchmarks.TextSuite.time_wrapping_unicode_heavy": [[0.001465916633605957], [], "4db4b38f51b05f4dc11b5a2908c118fe556a7d36b9e1d85fd18e28885a384db0", 1655825790139, 0.46382, [0.001449], [0.0015041], [0.001452], [0.00149], [7], [10]]}, "durations": {"<build>": 2.194915771484375}, "version": 2}

benchmarks/results/darrenburns-2022-mbp/06aa1271-virtualenv-py3.10-setuptools59.2.0.json

@@ -0,0 +1 @@
+{"commit_hash": "06aa127155e1e7ba0eef8317048483c00567d899", "env_name": "virtualenv-py3.10-setuptools59.2.0", "date": 1650369416000, "params": {"arch": "arm64", "cpu": "Apple M1 Pro", "machine": "darrenburns-2022-mbp", "num_cpu": "10", "os": "Darwin 21.2.0", "ram": "17179869184", "python": "3.10", "setuptools": "59.2.0"}, "python": "3.10", "requirements": {"setuptools": "59.2.0"}, "env_vars": {}, "result_columns": ["result", "params", "version", "started_at", "duration", "stats_ci_99_a", "stats_ci_99_b", "stats_q_25", "stats_q_75", "stats_number", "stats_repeat", "samples", "profile"], "results": {"benchmarks.ColorSuite.time_downgrade_to_eight_bit": [[1.7091647930768026e-07], [], "9da5ad0b5cfed4def0fe21fbea49ad4605f84bae78c584d9178a6b21be58d506", 1655825688714, 0.46688, [1.6982e-07], [1.7148e-07], [1.7069e-07], [1.7108e-07], [64792], [10]], "benchmarks.ColorSuite.time_downgrade_to_standard": [[1.7129722836399632e-07], [], "431bf40cae6650c65cdc6da70528f559c2e902abe9370cb73780dac5b5ef6826", 1655825688950, 0.46942, [1.696e-07], [1.7257e-07], [1.707e-07], [1.7176e-07], [64319], [10]], "benchmarks.ColorSuite.time_downgrade_to_windows": [[1.716386874893833e-07], [], "fef8d3fdb69ece95d49b5637f9d69760e29819d2d6e65e53e62356fec2e11b91", 1655825689186, 0.45755, [1.7015e-07], [1.7458e-07], [1.7097e-07], [1.7246e-07], [63895], [10]], "benchmarks.ColorSuiteCached.time_downgrade_to_eight_bit": [[1.712795841272511e-07], [], "5fdae4522a081f8212ac2d43d69bbc86b73876c4222f6ea36a80970afe663579", 1655825689419, 0.46564, [1.7038e-07], [1.7446e-07], [1.7101e-07], [1.7176e-07], [64249], [10]], "benchmarks.ColorSuiteCached.time_downgrade_to_standard": [[1.7105952255205924e-07], [], "3806eb6f32fcfc22ff57b23b1d09e25fc82c35a97183e285d257fb2e2b464f8f", 1655825689652, 0.46619, [1.6917e-07], [1.7239e-07], [1.7066e-07], [1.7141e-07], [64328], [10]], "benchmarks.ColorSuiteCached.time_downgrade_to_windows": [[1.7133783390386332e-07], [], "2844899e3d81f71bd0b997401e1d300394b3ca130a056eb6b9aaca15ef07f39d", 1655825689885, 0.43871, [1.6989e-07], [1.7387e-07], [1.7015e-07], [1.7238e-07], [58573], [10]], "benchmarks.PrettySuite.time_pretty": [[0.0010407645953819157], [], "12ef039b78ab19f0024f810fc30791bfe497731139b30a8c8ea7aef36ef9fed2", 1655825690103, 0.4594, [0.0010322], [0.0010962], [0.0010382], [0.0010595], [10], [10]], "benchmarks.PrettySuite.time_pretty_indent_guides": [[0.0014682886955727423], [], "27d39951a834104a09759cd0c9b1efe8570946400d606a04baad7b0e2355a259", 1655825690331, 0.45839, [0.0014622], [0.0014944], [0.0014645], [0.0014742], [7], [10]], "benchmarks.PrettySuite.time_pretty_justify_center": [[0.0011519074388262299], [], "51fe6d435fa7bcd605b26131da960edffb88929baa7aca98c9b3f7b23364cb6f", 1655825690557, 0.45507, [0.0011384], [0.001188], [0.0011414], [0.0011797], [9], [10]], "benchmarks.StyleSuite.time_parse_ansi": [[1.1533400223667848e-07], [], "30751ae63d82770f620ab5f807faf7437a5a7f2309db0c6403adb23ce9571ee5", 1655825690785, 0.46737, [1.141e-07], [1.1738e-07], [1.1497e-07], [1.1572e-07], [95679], [10]], "benchmarks.StyleSuite.time_parse_hex": [[1.1495592763776299e-07], [], "4d64f24e35306bc59f161cfd8e9542f1f76521ac58951af3841fba1722a9917b", 1655825691020, 0.44095, [1.1429e-07], [1.1904e-07], [1.147e-07], [1.1526e-07], [87450], [10]], "benchmarks.StyleSuite.time_parse_mixed_complex_style": [[1.1496228324955617e-07], [], "9a9eff6e02c4c05312809b98da8d740a48c93f8718ff7ba74cfec9e3f956dbd8", 1655825691241, 0.46498, [1.1441e-07], [1.16e-07], [1.1478e-07], [1.1518e-07], [95357], [10]], "benchmarks.SyntaxWrappingSuite.time_text_thin_terminal_heavy_wrapping": [[0.007626176986377686], [], "bcf6771787d6f643c3a02ed76b9045b8c773101dd7d307f989596e535a1dc8fa", 1655825691474, 0.50547, [0.0075528], [0.0077011], [0.007599], [0.0076355], [2], [10]], "benchmarks.SyntaxWrappingSuite.time_text_thin_terminal_medium_wrapping": [[0.007669510261621326], [], "df349deebd0cb3fe2602808efb2cc95270bdd3ff3734e07c13348039c5385ff9", 1655825691719, 0.53188, [0.0075999], [0.0087976], [0.0076171], [0.0086166], [2], [10]], "benchmarks.SyntaxWrappingSuite.time_text_wide_terminal_no_wrapping": [[0.00778645824175328], [], "0af0a4fdbcad1978765c9980b246270adec7d7917b7fb7ce9f544a55892503c2", 1655825691980, 0.51245, [0.0076697], [0.0079784], [0.0077158], [0.0078867], [2], [10]], "benchmarks.TableSuite.time_table_heavy_wrapping": [[0.0017417673952877522], [], "ca515a9739c1e0f8eb922420f9f9caf27321fb13c8bd0bc49b207a0588b370de", 1655825692243, 0.45091, [0.0017356], [0.0017924], [0.0017389], [0.0017537], [6], [10]], "benchmarks.TableSuite.time_table_no_wrapping": [[0.0010781229473650455], [], "8842a5f141d8208ba2bab66e4973e978cb5d0615f326af5d70385ff8fa44b3b9", 1655825692470, 0.44714, [0.0010707], [0.001086], [0.0010716], [0.001083], [10], [10]], "benchmarks.TextSuite.time_align_center": [[0.0003790200549971174], [], "f51eebb0dd72719da589ba30bbd85be25adf556231f15da3b8694499bb5b124f", 1655825692693, 0.44863, [0.0003726], [0.00038489], [0.00037424], [0.00038211], [27], [10]], "benchmarks.TextSuite.time_align_center_unicode_heavy": [[0.0003457743170050283], [], "6f157a0bd86b9db1c709c8fa9716458f797106b55ecd35afab408bd281b27e40", 1655825692913, 0.44784, [0.00033898], [0.00035324], [0.00034076], [0.00035013], [30], [10]], "benchmarks.TextSuite.time_divide": [[2.5513468765068887e-05], [], "64851da7a4fff5f7eedf5d6f18883aeb59a43decf556c31e627b6973bd1cc34e", 1655825693134, 0.4539, [2.5377e-05], [2.5595e-05], [2.5431e-05], [2.5551e-05], [430], [10]], "benchmarks.TextSuite.time_divide_unicode_heavy": [[0.00018499461243507163], [], "703b70a87fe0aa1599bb2e397e436f2387baf8cf7dcf349952df217899b97097", 1655825693367, 0.45959, [0.0001845], [0.00018991], [0.00018463], [0.00018566], [58], [10]], "benchmarks.TextSuite.time_fit": [[4.3716123592623365e-05], [], "8eab5a31717088de197d2d9f60d4e1658dbf3941e1afc4a378134fc8683c8bef", 1655825693597, 0.45222, [4.3385e-05], [4.5201e-05], [4.3469e-05], [4.4187e-05], [246], [10]], "benchmarks.TextSuite.time_fit_unicode_heavy": [[0.00032998106061396277], [], "7154022579acd99d94691787cdf31162b15e38998dbc46d85250baacfdb339ef", 1655825693828, 0.465, [0.00032351], [0.00033141], [0.00032466], [0.00033036], [33], [10]], "benchmarks.TextSuite.time_indent_guides": [[0.000357395828830014], [], "5a3722c26c96d1ef013e493ae4d2f99aa04f989ae6a8229123afd9d80f38a384", 1655825694061, 0.44938, [0.00035535], [0.00035968], [0.00035583], [0.00035807], [29], [10]], "benchmarks.TextSuite.time_render": [[4.7052404072466255e-06], [], "28f30de133a59a0ae0c7e34075766a5a7e492acb6401c8ceb24b6d0c4002db53", 1655825694285, 0.45785, [4.6891e-06], [4.7381e-06], [4.6974e-06], [4.7121e-06], [2344], [10]], "benchmarks.TextSuite.time_render_unicode_heavy": [[8.548769593884157e-05], [], "71f96ca5c6fe650b498a68a82f7268a1cd3d4b003a01d620fa0456b0827311e2", 1655825694518, 0.46041, [8.4844e-05], [8.968e-05], [8.5212e-05], [8.5647e-05], [127], [10]], "benchmarks.TextSuite.time_split": [[3.5525026931208656e-05], [], "8ced6624e81ea79c121959a499bd08a83578f32be271fce55bad42196ba221b7", 1655825694749, 0.45955, [3.5263e-05], [3.6138e-05], [3.5425e-05], [3.5607e-05], [298], [10]], "benchmarks.TextSuite.time_split_unicode_heavy": [[0.0002795822403736805], [], "edcdec63428ba276875d287976df2ef6ea68e66a44dfe252a80eecd7705aa47d", 1655825694979, 0.45868, [0.00027644], [0.00028538], [0.00027811], [0.00028017], [38], [10]], "benchmarks.TextSuite.time_wrapping": [[0.0011073853936977684], [], "7ee504db351412170e9e040a3c5f76a06ceb92b020dfd04c3d0ce3f2b7f5bc58", 1655825695208, 0.44965, [0.0011023], [0.0011451], [0.0011051], [0.0011183], [10], [10]], "benchmarks.TextSuite.time_wrapping_unicode_heavy": [[0.0013585911219706759], [], "4db4b38f51b05f4dc11b5a2908c118fe556a7d36b9e1d85fd18e28885a384db0", 1655825695432, 0.45998, [0.0013531], [0.001392], [0.0013566], [0.0013612], [8], [10]]}, "durations": {"<build>": 1.8455781936645508}, "version": 2}