Merge branch 'willmcgugan:master' into codespell

jizongFox · Oct 15, 2021 · cd40098 · cd40098
2 parents 215efa6 + 0dc08ea
commit cd40098
Show file tree

Hide file tree

Showing 10 changed files with 79 additions and 46 deletions.
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -4,6 +4,7 @@ The following people have contributed to the development of Rich:
 
 <!-- Add your name below, sort alphabetically by surname. Link to Github profile / your home page. -->
 
+- [Gregory Beauregard](https://github.com/GBeauregard/pyffstream)
 - [Pete Davison](https://github.com/pd93)
 - [Oleksis Fraga](https://github.com/oleksis)
 - [Finn Hughes](https://github.com/finnhughes)

diff --git a/README.md b/README.md
@@ -18,6 +18,7 @@
  • [Schwizerdütsch readme](https://github.com/willmcgugan/rich/blob/master/README.de-ch.md)
  • [हिन्दी readme](https://github.com/willmcgugan/rich/blob/master/README.hi.md)
  • [Português brasileiro readme](https://github.com/willmcgugan/rich/blob/master/README.pt-br.md)
+ • [Italian readme](https://github.com/willmcgugan/rich/blob/master/README.it.md)
 
 Rich is a Python library for _rich_ text and beautiful formatting in the terminal.
 

diff --git a/README.pt-br.md b/README.pt-br.md
@@ -18,19 +18,19 @@
  • [हिन्दी readme](https://github.com/willmcgugan/rich/blob/master/README.hi.md)
  • [Português brasileiro readme](https://github.com/willmcgugan/rich/blob/master/README.pt-br.md)
 
-Rich é uma biblioteca Python para _rich_ text e formatação de estilos no termial.
+Rich é uma biblioteca Python para _rich_ text e formatação de estilos no terminal.
 
-A [API do Rich](https://rich.readthedocs.io/en/latest/) permite adicionar cores e estilos no output do termial de forma fácil. Rich também permite formataçao de tabelas, barra de progresso, markdown, highlight de sintaxe de código fonte, rastreio de erros (traceback), e muito mais.
+A [API do Rich](https://rich.readthedocs.io/en/latest/) permite adicionar cores e estilos no output do terminal de forma fácil. Rich também permite formataçao de tabelas, barra de progresso, markdown, highlight de sintaxe de código fonte, rastreio de erros (traceback) e muito mais.
 
 ![Funcões](https://github.com/willmcgugan/rich/raw/master/imgs/features.png)
 
-Para mais detalhes, veja um vídeo de introdução so Rick em [calmcode.io](https://calmcode.io/rich/introduction.html) por [@fishnets88](https://twitter.com/fishnets88).
+Para mais detalhes, veja um vídeo de introdução so Rich em [calmcode.io](https://calmcode.io/rich/introduction.html) por [@fishnets88](https://twitter.com/fishnets88).
 
 Veja aqui [o que estão falando sobre o Rich](https://www.willmcgugan.com/blog/pages/post/rich-tweets/).
 
 ## Compatibilidade
 
-Rich funciona no Linux, OSX e Windows. True color / emoji funciona no novo Terminal do Windows, o terminal classico é limitado a 16 cores. Rich requer Python 3.6.1 or later.
+Rich funciona no Linux, OSX e Windows. True color / emoji funciona no novo Terminal do Windows, o terminal classico é limitado a 16 cores. Rich requer Python 3.6.1 ou superior.
 
 Rich funciona com [Jupyter notebooks](https://jupyter.org/) sem a necessidade de configurações adicionais.
 
@@ -111,7 +111,7 @@ Voce pode usar o objeto do Console para gerar facilmente uma saída para o termi
 
 ## Inspect do Rich
 
-O Rich tem uma função [inspect](https://rich.readthedocs.io/en/latest/reference/init.html?highlight=inspect#rich.inspect) que gera um relatório de qualquer objeto no Python, como classes, instancias ou funções nativas.
+O Rich tem uma função [inspect](https://rich.readthedocs.io/en/latest/reference/init.html?highlight=inspect#rich.inspect) que gera um relatório de qualquer objeto no Python, como classes, instâncias ou funções nativas.
 
 ```python
 >>> my_list = ["foo", "bar"]
@@ -185,18 +185,18 @@ Para imprimir um emoji no console, coloque o nome do emoji entre dois ":" (dois
 😃 🧛 💩 👍 🦝
 ```
 
-Please use this feature wisely.
+Por favor use esse recurso com sabedoria.
 
 </details>
 
 <details>
 <summary>Tabelas</summary>
 
-O Rich pode imprimir [tables](https://rich.readthedocs.io/en/latest/tables.html) flexiveis usando caracteres unicode como bordas. Existem várias opções de formatação de bordas, estilos, alinhamento das celulas etc.
+O Rich pode imprimir [tables](https://rich.readthedocs.io/en/latest/tables.html) flexíveis usando caracteres unicode como bordas. Existem várias opções de formatação de bordas, estilos, alinhamento das celulas, etc.
 
 ![table movie](https://github.com/willmcgugan/rich/raw/master/imgs/table_movie.gif)
 
-A animação acima foi gerada com o arquivo [table_movie.py](https://github.com/willmcgugan/rich/blob/master/examples/table_movie.py) da pasta de exeplos.
+A animação acima foi gerada com o arquivo [table_movie.py](https://github.com/willmcgugan/rich/blob/master/examples/table_movie.py) da pasta de exemplos.
 
 Veja um exemplo mais simple:
 
@@ -236,7 +236,7 @@ Que gera o seguinte resultado:
 
 Observe que o markup é renderizado da mesma for que em `print()` e `log()`. De fato, tudo que é renderizável pelo Rich pode ser incluído nos cabeçalhos ou linhas (até mesmo outras tabelas).
 
-A class `Table` é inteligente o suficiente para ajustar o tamanho das colunas para caber na largura do terminal, quebrando o texto em novas linhas como necessário. Veja a seguir o mesmo exemplo, só que desta vez com um terminal menor do que o tamanho original da tabela:
+A classe `Table` é inteligente o suficiente para ajustar o tamanho das colunas para caber na largura do terminal, quebrando o texto em novas linhas quando necessário. Veja a seguir o mesmo exemplo, só que desta vez com um terminal menor do que o tamanho original da tabela:
 
 ![table2](https://github.com/willmcgugan/rich/raw/master/imgs/table2.png)
 
@@ -256,7 +256,6 @@ for step in track(range(100)):
     do_step(step)
 ```
 
-It's not much harder to add multiple progress bars. Here's an example taken from the docs:
 Adicionar multiplas barras de progresso também é simples. Veja outro exemplo que existe na documentação:
 
 ![progress](https://github.com/willmcgugan/rich/raw/master/imgs/progress.gif)
@@ -265,7 +264,7 @@ As colunas podem ser configuradas pra mostrar qualquer detalho necessário. As c
 
 ![progress](https://github.com/willmcgugan/rich/raw/master/imgs/downloader.gif)
 
-Para testar isso no seu terminal, use o arquivo [examples/downloader.py](https://github.com/willmcgugan/rich/blob/master/examples/downloader.py) para fazer o download de multiplas URLs simultaneamente, exibindo o progress de cada download.
+Para testar isso no seu terminal, use o arquivo [examples/downloader.py](https://github.com/willmcgugan/rich/blob/master/examples/downloader.py) para fazer o download de multiplas URLs simultaneamente, exibindo o progresso de cada download.
 
 </details>
 
@@ -319,7 +318,6 @@ Isso gera o seguinte resultado:
 
 ![markdown](https://github.com/willmcgugan/rich/raw/master/imgs/tree.png)
 
-Veja o exemplo em [tree.py](https://github.com/willmcgugan/rich/blob/master/examples/tree.py) de um script that displays a tree view of any directory, similar to the linux `tree` command.
 Veja o exemplo em [tree.py](https://github.com/willmcgugan/rich/blob/master/examples/tree.py) de um código que gera uma árvore de exibição de um dicionário, semelhante ao comando `tree` do linux.
 
 </details>
@@ -340,7 +338,6 @@ directory = os.listdir(sys.argv[1])
 print(Columns(directory))
 ```
 
-The following screenshot is the output from the [columns example](https://github.com/willmcgugan/rich/blob/master/examples/columns.py) which displays data pulled from an API in columns:
 O screenshot a seguir é do resultado do [exemplo de colunas](https://github.com/willmcgugan/rich/blob/master/examples/columns.py) formatando em colunas os dados extraidos de uma API:
 
 ![columns](https://github.com/willmcgugan/rich/raw/master/imgs/columns.png)
@@ -444,14 +441,14 @@ Aqui estão alguns projetos que usam o Rich:
 - [cansarigol/pdbr](https://github.com/cansarigol/pdbr)
   pdb + Rich para auxiliar no debug
 - [plant99/felicette](https://github.com/plant99/felicette)
-  Imagem de satélites para tolos.
+  Imagem de satélites para iniciantes.
 - [seleniumbase/SeleniumBase](https://github.com/seleniumbase/SeleniumBase)
   Automatize & teste 10x mais rápido com Selenium & pytest. Baterias inclusas.
 - [smacke/ffsubsync](https://github.com/smacke/ffsubsync)
   Automagicamente sincronize legendas com vídeos.
 - [tryolabs/norfair](https://github.com/tryolabs/norfair)
   Biblioteca Python para adicionar rastreio em tempo real de objetos 2D em qualquer detector.
-- [ansible/ansible-lint](https://github.com/ansible/ansible-lint) Ansible-lint verifica boas praticas e comportamento que podem ser melhorados.
+- [ansible/ansible-lint](https://github.com/ansible/ansible-lint) Ansible-lint verifica boas práticas e comportamento que podem ser melhorados.
 - [ansible-community/molecule](https://github.com/ansible-community/molecule) Framework de test para Ansible Molecule
 - +[Muitos outros](https://github.com/willmcgugan/rich/network/dependents)!
 

diff --git a/docs/source/console.rst b/docs/source/console.rst
@@ -384,7 +384,7 @@ Interactive mode
 Rich will remove animations such as progress bars and status indicators when not writing to a terminal as you probably don't want to write these out to a text file (for example). You can override this behavior by setting the ``force_interactive`` argument on the constructor. Set it to True to enable animations or False to disable them.
 
 .. note::
-    Some CI systems support ANSI color and style but not anything that moves the cursor or selectively refreshes parts of the terminal. For these you might want to set ``force_terminal`` to ``True`` and ``force_interactve`` to ``False``.
+    Some CI systems support ANSI color and style but not anything that moves the cursor or selectively refreshes parts of the terminal. For these you might want to set ``force_terminal`` to ``True`` and ``force_interactive`` to ``False``.
 
 Environment variables
 ---------------------

diff --git a/docs/source/traceback.rst b/docs/source/traceback.rst
@@ -26,7 +26,7 @@ The ``show_locals=True`` parameter causes Rich to display the value of local var
 See `exception.py <https://github.com/willmcgugan/rich/blob/master/examples/exception.py>`_ for a larger example.
 
 
-Traceback handler
+Traceback Handler
 -----------------
 
 Rich can be installed as the default traceback handler so that all uncaught exceptions will be rendered with highlighting. Here's how::
@@ -36,6 +36,27 @@ Rich can be installed as the default traceback handler so that all uncaught exce
 
 There are a few options to configure the traceback handler, see :func:`~rich.traceback.install` for details.
 
+Automatic Traceback Handler
+^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+In some cases you may want to have the traceback handler installed automatically without having to worry about importing the code in your module. You can do that by modifying the `sitecustomize.py` in your virtual environment. Typically it would be located in your virtual environment path, underneath the `site-packages` folder, something like this::
+
+    ./.venv/lib/python3.9/site-packages/sitecustomize.py
+
+In most cases this file will not exist. If it doesn't exist, you can create it by::
+
+    $ touch .venv/lib/python3.9/site-packages/sitecustomize.py
+
+Add the following code to the file::
+
+    from rich.traceback import install
+    install(show_locals=True)
+
+At this point, the traceback will be installed for any code that is run within the virtual environment.
+
+.. note::
+    If you plan on sharing your code, it is probably best to include the traceback install in your main entry point module.
+
 
 Suppressing Frames
 ------------------
@@ -73,4 +94,5 @@ Here's an example of printing an recursive error::
     try:
         foo(1)
     except Exception:
-        console.print_exception(max_frames=20)
+        console.print_exception(max_frames=20)
+