nya-codeblock 0.1.0__py3-none-any.whl

nya_codeblock/__init__.py

@@ -0,0 +1,9 @@
+from .codeblock import codeblock, codeblocks, codeblocks_from_exception
+from .uncodeblock import uncodeblock
+
+__all__ = [
+	"codeblock",
+	"codeblocks",
+	"codeblocks_from_exception",
+	"uncodeblock",
+]

nya_codeblock/_version.py

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

nya_codeblock/codeblock.py

@@ -0,0 +1,120 @@
+from collections.abc import Callable
+
+BACKTICK = "`"
+BACKTICKS = 3 * BACKTICK
+NEWLINE = "\n"
+
+
+def _default_cut_at(text: str, max_length: int) -> str:
+	"""Cut text at max_length, if text is longer than max_length.
+
+	Args:
+		text: The text to cut.
+		max_length: The maximum length of the output str.
+	Returns:
+		str: The text cut at max_length.
+	"""
+	return text[:max_length]
+
+
+def codeblock(
+	text: str,
+	*,
+	langcode: str = "",
+	max_length: int = 1984,
+	fn_cut_at: Callable[[str, int], str] = _default_cut_at,
+	smart_empty: bool = True,
+	convert_three_backticks_to_apostrophes: bool = False,
+) -> str:
+	r"""Pack text into a Discord codeblock. This will cut it to a max_length with a default for Discord, if you dont want this, set max_length to your desired length or -1 means text's length.
+
+	Note: May return str with len > max_length if max_length is ridicously low such that not even `'''\nlangcode'''` fits
+
+	Args:
+		text: The text to put in the codeblock body.
+		langcode: The language code to use in discord codeblock, for example "py".
+		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.
+		convert_three_backticks_to_apostrophes: If true, any backticks in the text will be converted to apostrophes. This prevents the codeblock from being broken by backticks in the text.
+
+	Returns:
+		str: A str of the form ```langcode\ntext``` with a length of or less than max_length.
+	"""
+	if smart_empty and not text:
+		text = " "
+
+	if convert_three_backticks_to_apostrophes:
+		text = text.replace(BACKTICKS, "'''")
+
+	length_of_parts = len(BACKTICKS) + len(langcode) + len(NEWLINE) + len(BACKTICKS)
+
+	return "".join((
+		BACKTICKS,
+		langcode,
+		NEWLINE,
+		fn_cut_at(
+			text,
+			(max_length - length_of_parts if max_length != -1 else len(text)),
+		),
+		BACKTICKS,
+	))
+
+
+def codeblocks(
+	text0: str,
+	*texts: str,
+	langcodes: tuple[str, ...] | None = None,
+	max_length: int = 1984,
+	fn_cut_at: Callable[[str, int], str] = _default_cut_at,
+	smart_empty: bool = True,
+	convert_three_backticks_to_apostrophes: bool = False,
+) -> str:
+	r"""Mutliple-`codeblock()`. For more info read codeblock() docstring.
+
+	Args:
+		text0: 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.
+		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.
+
+	Returns:
+		str: A str of the form ```langcode\ntext``` with a length of or less than max_length.
+	"""
+	texts = text0, *texts
+
+	if langcodes is None:
+		langcodes: tuple[str, ...] = ("",) * len(texts)
+
+	out = ""
+
+	for text, langcode in zip(texts, langcodes, strict=True):
+		out += codeblock(
+			text,
+			langcode=langcode,
+			max_length=max_length - len(out),
+			fn_cut_at=fn_cut_at,
+			smart_empty=smart_empty,
+			convert_three_backticks_to_apostrophes=convert_three_backticks_to_apostrophes,
+		)
+
+	return out
+
+
+def codeblocks_from_exception(
+	e: BaseException,
+	*,
+	max_length: int = 1800,
+) -> str:
+	return codeblocks(
+		extract_error(e),
+		extract_traceback(e),
+		langcodes=(
+			"txt",
+			"py",
+		),
+		max_length=max_length,
+		smart_empty=True,
+	)

nya_codeblock/uncodeblock.py

@@ -0,0 +1,19 @@
+from .codeblock import BACKTICKS, NEWLINE
+
+
+def uncodeblock(text: str) -> str:
+	"""*Try to* remove any markdown/discord codeblocks along with their langcodes if any are found.
+
+	Args:
+		text: The text to remove markdown/discord codeblocks from.
+
+	Returns:
+		str: The text with any markdown/discord codeblocks removed.
+	"""
+	if text[-3:] == BACKTICKS and text[:3] == BACKTICKS:
+		code_start = 3
+		code_end = -3
+		if NEWLINE in text[3:]:  # Check if there is a language code specified
+			code_start = text.index(NEWLINE) + 1
+		return text[code_start:code_end].strip()
+	return text

nya_codeblock-0.1.0.dist-info/METADATA

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

nya_codeblock-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+nya_codeblock/__init__.py,sha256=6izyXLG495houwqs_p-FvYOW6fj5LWYkUPHQul0nPho,199
+nya_codeblock/__main__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nya_codeblock/_version.py,sha256=5HYXODBNk5J9vVbUrfu716lCND-BNE2LCfb2Jp8jsXs,26
+nya_codeblock/codeblock.py,sha256=FXoD_aZyS5RolAlM3TNX7CxkzFLVWnHc_Ueu_IWxIGA,3856
+nya_codeblock/uncodeblock.py,sha256=V-Xt8yTFABOLHKeBomw2pa6xfXWFttTmkrL4peMqpMo,579
+nya_codeblock-0.1.0.dist-info/METADATA,sha256=Ktexi5zv6E_doTSALNfwZBKJz91_GtHDWnU8MDwj7hI,375
+nya_codeblock-0.1.0.dist-info/WHEEL,sha256=lCkmxWfQsSc9CfIClYeavTdQeEX2toPqufh9gI35EQA,87
+nya_codeblock-0.1.0.dist-info/RECORD,,

nya_codeblock-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.31.0
+Root-Is-Purelib: true
+Tag: py3-none-any