nya-codeblock 0.1.0__tar.gz → 0.1.1__tar.gz

{nya_codeblock-0.1.0 → nya_codeblock-0.1.1}/PKG-INFO

@@ -1,8 +1,9 @@
 Metadata-Version: 2.4
 Name: nya-codeblock
-Version: 0.1.0
+Version: 0.1.1
 Summary: Provide helpful functions to convert str into a markdown/discord codeblock. Ported from my own package, tcrutils.
 Requires-Python: >=3.11
+Requires-Dist: nya-extract-error>=0.1.0
 Description-Content-Type: text/markdown
 
 # nya-codeblock

{nya_codeblock-0.1.0 → nya_codeblock-0.1.1}/pyproject.toml

@@ -4,7 +4,10 @@ dynamic         = ['version']
 description     = 'Provide helpful functions to convert str into a markdown/discord codeblock. Ported from my own package, tcrutils.'
 readme          = "README.md"
 requires-python = ">=3.11"
-dependencies    = []
+
+dependencies = [ #
+	"nya-extract-error>=0.1.0",
+]
 
 [build-system]
 requires      = ["hatchling"]

nya_codeblock-0.1.1/src/nya_codeblock/_version.py

@@ -0,0 +1 @@
+__version__: str = "0.1.1"

{nya_codeblock-0.1.0 → nya_codeblock-0.1.1}/src/nya_codeblock/codeblock.py

@@ -1,5 +1,7 @@
 from collections.abc import Callable
 
+from nya_extract_error import extract_error, extract_traceback
+
 BACKTICK = "`"
 BACKTICKS = 3 * BACKTICK
 NEWLINE = "\n"
@@ -62,7 +64,7 @@ def codeblock(
 
 
 def codeblocks(
-	text0: str,
+	text: str,
 	*texts: str,
 	langcodes: tuple[str, ...] | None = None,
 	max_length: int = 1984,
@@ -70,12 +72,15 @@ def codeblocks(
 	smart_empty: bool = True,
 	convert_three_backticks_to_apostrophes: bool = False,
 ) -> str:
-	r"""Mutliple-`codeblock()`. For more info read codeblock() docstring.
+	r"""Mutliple-`codeblock()`. For more info read `codeblock()` docstring.
+
+	!!! ⚠️ Warning
+		Max length is not guaranteed to be respected, since this is doing codeblock() in a loop, and the lowest amount of characters that can be returned is `((7 + len(langcode)) := len(`"```{langcode}\n```"`)) * len((text, *texts))`, therefore it can overflow max_length by this amount. Set a more conservative max_length or do further processing like a hard cutoff (`output[:2000]`) (breaks formatting, but can be acceptable if doesnt triggerr in 99.9% of cases), or fork/compose this function if you need more control.
 
 	Args:
-		text0: The first text to put in the codeblock body.
+		text: The first text to put in the codeblock body.
 		*texts: The rest of the texts to put in the codeblock body.
-		langcodes: The language codes to use in discord codeblock, for example "py". If None, all langcodes will be empty strings. If provided, must be of same length as the total amount of texts passed in including text0.
+		langcodes: The language codes to use in discord codeblock, for example "py". If None, all langcodes will be empty strings. If provided, must be of same length as the total amount of all texts passed in (by all texts here i mean `(text, *texts)`).
 		max_length: The maximum length of the output str.
 		fn_cut_at: A Callable[[str, int], str] which's returned string is of or less than the passed in int in length.
 		smart_empty: If true, if `text` is '' (an empty string) it will be changed to ' ' (a space). This prevents the codeblock to think langcode is the body of the codeblock if no text is supplied.
@@ -83,7 +88,7 @@ def codeblocks(
 	Returns:
 		str: A str of the form ```langcode\ntext``` with a length of or less than max_length.
 	"""
-	texts = text0, *texts
+	texts = text, *texts
 
 	if langcodes is None:
 		langcodes: tuple[str, ...] = ("",) * len(texts)

nya_codeblock-0.1.1/tests/test_codeblocks.py

@@ -0,0 +1,26 @@
+from nya_codeblock import codeblocks
+
+
+def test_codeblocks():
+	code1 = "print('Hello, World!')"
+	code2 = "print('Goodbye, World!')"
+
+	result = codeblocks(
+		code1,
+		code2,
+		langcodes=("python", "python"),
+	)
+
+	assert result == f"```python\n{code1}``````python\n{code2}```"
+
+
+def test_codeblocks_no_langcodes():
+	code1 = "print('Hello, World!')"
+	code2 = "print('Goodbye, World!')"
+
+	result = codeblocks(
+		code1,
+		code2,
+	)
+
+	assert result == f"```\n{code1}``````\n{code2}```"

nya_codeblock-0.1.1/tests/test_uncodeblock.py

@@ -0,0 +1,29 @@
+from nya_codeblock import codeblock, uncodeblock
+
+
+def test_uncodeblock():
+	code = "print('Hello, World!')"
+	langcode = "python"
+	code_block = f"```{langcode}\n{code}\n```"
+
+	extracted_code = uncodeblock(code_block)
+
+	assert extracted_code == code
+
+
+def test_uncodeblock_no_langcode():
+	code = "print('Hello, World!')"
+	code_block = f"```\n{code}\n```"
+
+	extracted_code = uncodeblock(code_block)
+
+	assert extracted_code == code
+
+
+def test_uncodeblock_from_codeblock():
+	code = "print('Hello, World!')"
+
+	code_block = codeblock(code, langcode="python")
+	extracted_code = uncodeblock(code_block)
+
+	assert extracted_code == code

{nya_codeblock-0.1.0 → nya_codeblock-0.1.1}/uv.lock

@@ -23,6 +23,9 @@ wheels = [
 [[package]]
 name = "nya-codeblock"
 source = { editable = "." }
+dependencies = [
+    { name = "nya-extract-error" },
+]
 
 [package.dev-dependencies]
 dev = [
@@ -30,10 +33,20 @@ dev = [
 ]
 
 [package.metadata]
+requires-dist = [{ name = "nya-extract-error", specifier = ">=0.1.0" }]
 
 [package.metadata.requires-dev]
 dev = [{ name = "pytest", specifier = ">=9.1.1" }]
 
+[[package]]
+name = "nya-extract-error"
+version = "0.1.1"
+source = { registry = "https://pypi.org/simple" }
+sdist = { url = "https://files.pythonhosted.org/packages/7d/05/1eb511b342311eaafeae48d91bb70db33037d4fa242aa4592f26797a0aca/nya_extract_error-0.1.1.tar.gz", hash = "sha256:097a5eb70e59eb58facfbf15518a2495abfa0032e6c78e3e938deba794bb8c63", size = 13880, upload-time = "2026-07-20T09:26:44.157Z" }
+wheels = [
+    { url = "https://files.pythonhosted.org/packages/25/33/eaac4e16f3733a4f2e54d063fd8f549a3ad08814fc7461296a5eef63a310/nya_extract_error-0.1.1-py3-none-any.whl", hash = "sha256:bfc6b3025db1f68f89ac251aac6877471c7f781575d83939be9282478966ed42", size = 2199, upload-time = "2026-07-20T09:26:43.262Z" },
+]
+
 [[package]]
 name = "packaging"
 version = "26.2"

nya_codeblock-0.1.0/src/nya_codeblock/_version.py

@@ -1 +0,0 @@
-__version__: str = "0.1.0"