ferramenta calango: início

Author: ramalho

calango/README.md

@@ -0,0 +1,26 @@
+# Calango
+
+Processador de referências cruzadas para a publicação do 
+_Python Fluente Segunda Edição_ impresso em três columes.
+
+## Objetivo
+
+Encontrar e substituir as referências cruzadas que apontam
+para volumes diferentes.
+
+Por exemplo, no Capítulo 1, próximo da linha 744 há essa referência:
+
+````adoc
+Como implementar [...] será visto no <<ch_seq_methods>>,
+````
+
+Como aponta para um capítulo do volume 2, precisa ser reescrita assim:
+
+```adoc
+Como implementar [...] será visto no Capítulo 12 [vol.2, fpy.li/xyz],
+```
+
+Onde fpy.li/xyz direciona para:
+
+https://pythonfluente.com/2/#ch_seq_methods
+

calango/pyproject.toml

@@ -0,0 +1,22 @@
+[project]
+name = "calango"
+version = "0.1.0"
+description = "Processador de refeências cruzadas"
+readme = "README.md"
+authors = [
+    { name = "Luciano Ramalho", email = "luciano@ramalho.org" }
+]
+requires-python = ">=3.14"
+dependencies = []
+
+[project.scripts]
+calango = "calango:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.4.1",
+]

calango/src/calango/__init__.py

@@ -0,0 +1,2 @@
+def main() -> None:
+    print("Hello from calango!")

calango/src/calango/xrefs.py

@@ -0,0 +1,37 @@
+from enum import Enum, auto
+from dataclasses import dataclass
+
+
+class Kind(Enum):
+    PART = auto()
+    CHAPTER = auto()
+    SECTION = auto()
+    EXAMPLE = auto()
+    TABLE = auto()
+
+
+@dataclass
+class Target:
+    ident: str
+    vol: int = 0
+    chap: int = 0
+    numbers: tuple[int, ...] | None = None
+    kind: Kind = Kind.PART
+
+    def __post_init__(self):
+        self.kind = self.get_kind()
+
+    def get_kind(self) -> Kind:
+        if self.ident.startswith('ch_'):
+            return Kind.CHAPTER
+        raise ValueError(f'Kind of {self.ident!r} is unknown')
+
+
+def validate(xref):
+    return any([
+        xref.startswith('ch_'),
+        xref.endswith('_ex'),
+        xref.endswith('_sec'),
+        xref.endswith('_part'),
+        xref.endswith('_tbl'),
+    ])

calango/tests/test_xrefs.py

@@ -0,0 +1,8 @@
+import pytest
+from calango.xrefs import Target, Kind
+
+def test_recursion_depth():
+    with pytest.raises(ValueError) as excinfo:
+        _ = Target('something')
+
+    assert "Kind of 'something' is unknown" in str(excinfo.value)

calango/uv.lock

@@ -744,7 +744,7 @@ uma para depuração e registro (_log_), outra para apresentar aos usuários fin
 Emular sequências, como mostrado com o exemplo do `FrenchDeck`, é um dos usos mais comuns dos métodos especiais.
 Por exemplo, bibliotecas de banco de dados frequentemente devolvem resultados de consultas na forma de coleções similares a sequências.
 Tirar o máximo proveito dos tipos de sequências existentes é o assunto do <<ch_sequences>>.
-Como implementar suas próprias sequências será visto na <<ch_seq_methods>>,
+Como implementar suas próprias sequências será visto no <<ch_seq_methods>>,
 onde criaremos uma extensão multidimensional da classe `Vector`.
 
 Graças à sobrecarga de operadores, Python oferece uma rica seleção de tipos numéricos,

online/cap01.adoc

@@ -13,7 +13,6 @@
 
 import sys
 
-PREFIX = 'asciidoctor: INFO: possible invalid reference: '
 
 
 def good_id(xref):
@@ -25,6 +24,10 @@ def good_id(xref):
         xref.endswith('_tbl'),
     ])
 
+
+PREFIX = 'asciidoctor: INFO: possible invalid reference: '
+
+
 def main():
     # see this module's docstring for input file
     adoc_msgs = sys.argv[1]

print/xrefs/filter_xrefs.py

@@ -741,7 +741,7 @@ uma para depuração e registro (_log_), outra para apresentar aos usuários fin
 Emular sequências, como mostrado com o exemplo do `FrenchDeck`, é um dos usos mais comuns dos métodos especiais.
 Por exemplo, bibliotecas de banco de dados frequentemente devolvem resultados de consultas na forma de coleções similares a sequências.
 Tirar o máximo proveito dos tipos de sequências existentes é o assunto do <<ch_sequences>>.
-Como implementar suas próprias sequências será visto na <<ch_seq_methods>>,
+Como implementar suas próprias sequências será visto no <<ch_seq_methods>>,
 onde criaremos uma extensão multidimensional da classe `Vector`.
 
 Graças à sobrecarga de operadores, Python oferece uma rica seleção de tipos numéricos,

vol1/cap01.adoc

@@ -1,6 +1,7 @@
 = Python Fluente: dados e funções
 :doctype: book
 :media: prepress
+:hide-uri-scheme:
 :pdf-page-size: [17cm, 24cm]
 :source-highlighter: rouge
 :author: Luciano Ramalho