types-remover 1.0.0__py3-none-any.whl → 1.0.2__py3-none-any.whl

types_remover/__init__.py

@@ -1,6 +1,32 @@
+from typing import Optional, Literal
+
 from ._types_remover_ast import remove_types_ast as remove_types_ast
 from ._types_remover_if import remove_types as remove_types_if
 
 
-__all__ = ['remove_types_if', 'remove_types_ast']
+__all__ = ['remove_types','remove_types_if', 'remove_types_ast']
 __author__ = 'EasternFarmer'
+
+
+def remove_types(
+    path: str,
+    *,
+    implementation: Literal['ast', 'if'] = 'ast',
+    return_str: bool = False,
+    output_file_path: Optional[str] = None
+    ) -> Optional[str]:
+
+    if implementation == 'ast':
+        return remove_types_ast(
+            path,
+            return_str = return_str,
+            output_file_path = output_file_path
+            )
+    elif implementation == 'if':
+        return remove_types_if(
+            path,
+            return_str = return_str,
+            output_file_path = output_file_path
+            )
+    else:
+        raise ValueError('Invalid implementation specified.')

types_remover/_types_remover_ast.py

@@ -1,24 +1,26 @@
 import ast
+from typing import Optional
 
 
 class _DowngradeAnnAssign(ast.NodeTransformer):
 	"""Converts AnnAssign nodes (annotated assignment) to simpler Assign nodes."""
 
-	def visit_AnnAssign(self, node: ast.AnnAssign) -> ast.Assign | None:
+	def visit_AnnAssign(self, node: ast.AnnAssign) -> Optional[ast.Assign]:
 		if node.value is not None:
 			return ast.Assign(targets = [node.target], value = node.value)
 		return None  # just so mypy can leave me alone
 
 
-def remove_types_ast(path: str, *, return_str: bool = False, output_file_path: str = 'output.py') -> None | str:
+def remove_types_ast(path: str, *, return_str: bool = False, output_file_path: Optional[str] = None) -> Optional[str]:
 	"""
-		Strips the types declared in the file at **path**
-		Either one of return_str or output_file_path must be set
+		Strips the types declared in the file at **path** and outputs it to output_file_path
 		:param path: Required parameter deciding what file to strip from types
-		:param return_str: dictates if the function returns a str; can be mixed with output_file_path param
-		:param output_file_path: dictates where the function saves the data; can be mixed with return_str param
+		:param return_str: dictates if the function returns a str
+		:param output_file_path: dictates where the function saves the data
 		:return: str if return_str is True else None
 	"""
+	if output_file_path is None:
+		output_file_path = 'output.py'
 
 	with open(path) as f:
 		nodes = ast.parse(f.read())
@@ -35,8 +37,8 @@ def remove_types_ast(path: str, *, return_str: bool = False, output_file_path: s
 			node.returns = None
 	nodes = ast.fix_missing_locations(_DowngradeAnnAssign().visit(nodes))
 
-	if return_str:
-		return ast.unparse(nodes)
 	with open(output_file_path, 'w') as f:
 		f.writelines(ast.unparse(nodes))
+	if return_str:
+		return ast.unparse(nodes)
 	return None  # just so mypy can leave me alone

types_remover/_types_remover_if.py

@@ -1,4 +1,5 @@
 import re
+from typing import Optional
 
 
 def _parse_line(line: str) -> str | bool:
@@ -36,7 +37,17 @@ def _parse_def_statement(line: str) -> str:
     return f'{' ' * spaces}def {function_name}({', '.join(args2)}):'
 
 
-def remove_types(path: str, *, return_str: bool = False, output_file: str = 'output.py') -> None | str:
+def remove_types(path: str, *, return_str: bool = False, output_file_path: Optional[str] = None) -> Optional[str]:
+    """
+        Strips the types declared in the file at **path** and outputs it to output_file_path
+        :param path: Required parameter deciding what file to strip from types
+        :param return_str: dictates if the function returns a str
+        :param output_file_path: dictates where the function saves the data. defaults to 'output.py'
+        :return: str if return_str is True else None
+    """
+    if output_file_path is None:
+        output_file_path = 'output.py'
+
     with open(path) as f:
         file = [line.rstrip('\n') for line in f.readlines()]
 
@@ -140,8 +151,8 @@ def remove_types(path: str, *, return_str: bool = False, output_file: str = 'out
                 else: new_file.append(' ' * (len(tuple_line) - len(tuple_line.lstrip())) + ''.join(tuple_line.split()))
                 tuple_line = ''
 
+    with open(output_file_path, 'w') as f:
+        f.writelines('\n'.join(new_file))
     if return_str:
         return '\n'.join(new_file)
-    with open(output_file, 'w') as f:
-        f.writelines('\n'.join(new_file))
     return None

types_remover/cli.py

@@ -0,0 +1,25 @@
+"""
+The command-line interface for the ast version of the types remover
+"""
+import argparse
+from . import remove_types_ast
+
+
+def main():
+    parser = argparse.ArgumentParser(
+        description="types remover"
+    )
+    parser.add_argument(
+        "path", type=str,
+        help="Path to a file that\' going to be stripped "
+    )
+    parser.add_argument(
+        "--output", "-o",
+        help="name of the output file. defaults to output.py"
+    )
+    args = parser.parse_args()
+    remove_types_ast(args.path, output_file_path=args.output)
+    print("types stripped successfully")
+
+if __name__ == "__main__":
+    main()

{types_remover-1.0.0.dist-info → types_remover-1.0.2.dist-info}/METADATA

@@ -1,17 +1,15 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.2
 Name: types_remover
-Version: 1.0.0
+Version: 1.0.2
 Summary: A small package that removes types from a file
+Author-email: EasternFarmer <franek.banas1@gmail.com>
 Project-URL: Homepage, https://github.com/EasternFarmer/types_remover
 Project-URL: Issues, https://github.com/EasternFarmer/types_remover/issues
-Author-email: EasternFarmer <franek.banas1@gmail.com>
-License-Expression: GPL-3.0-or-later
-License-File: LICENSE
-Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
-Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
 Requires-Python: >=3.12
 Description-Content-Type: text/markdown
+License-File: LICENSE
 
 # Types remover(s)
 
@@ -19,12 +17,12 @@ Description-Content-Type: text/markdown
 
 
 This packet has two available functions `remove_types_ast` and `remove_types_if`, that are doing almost the same thing
-with implementation. <br>
+with different implementation. And one cmd command `remove-types` that uses argparse and `remove_types_ast`<br>
 
 From the tests I can tell you that `remove_types_ast` is on average 3,28 (average from 100 calls) times slower than
 `remove_types_if`
 
 ### IMPORTANT TO NOTE
 
-- The `remove_types_ast` function removes comments (not doc-strings)
-- Both functions turn multi-line data assignation into a one-line statement
+- The `remove_types_ast` function and `remove-types` cmd command both remove comments (not doc-strings)
+- Both functions turn multi-line data assignation into a one-line statement

types_remover-1.0.2.dist-info/RECORD

@@ -0,0 +1,10 @@
+types_remover/__init__.py,sha256=pjDIOIMn24mMYFYPMYFvQAJLdv9a9VovpPHqBFdvcAQ,891
+types_remover/_types_remover_ast.py,sha256=OeBhPnoWwy06a43TumXLYx3ncVdk1P1f7hJdCmwdaRw,1650
+types_remover/_types_remover_if.py,sha256=DLeQeVmclgPHm9NR0K21oPWTMLTGRQAa5nzlsQC0GYM,7562
+types_remover/cli.py,sha256=Yackgc-XYvZ3pqv72Uj8z3K9CLQcmc8HGsx-xdQrEBM,624
+types_remover-1.0.2.dist-info/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
+types_remover-1.0.2.dist-info/METADATA,sha256=wNL1z3vdCoj86Uuusu_T52e7ad9dI_mwSvw2FcWEG38,1249
+types_remover-1.0.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+types_remover-1.0.2.dist-info/entry_points.txt,sha256=tx3iH_DisPcRShwLxQYCdPh-MvuzzMqjsk16238Dwrk,56
+types_remover-1.0.2.dist-info/top_level.txt,sha256=qG2PHosubBxZs6X2olkvKfJovD2lIDP670kEe1bVRMw,14
+types_remover-1.0.2.dist-info/RECORD,,

{types_remover-1.0.0.dist-info → types_remover-1.0.2.dist-info}/WHEEL

@@ -1,4 +1,5 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.27.0
+Generator: setuptools (75.8.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
+

types_remover-1.0.2.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+remove-types = types_remover.cli:main

types_remover-1.0.2.dist-info/top_level.txt

@@ -0,0 +1 @@
+types_remover

types_remover-1.0.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-types_remover/__init__.py,sha256=9rGAkBksywski5kmgbrPPvXS2Z9QrPoW90Kp1cc3Bv0,213
-types_remover/_types_remover_ast.py,sha256=Qe7puRK_lvTr0D9_COaW9Dub2_mHvVkNdpnIwLOi6l8,1652
-types_remover/_types_remover_if.py,sha256=m11y3dppo-KyTBIf_v4qtJoQyrhw6Va7NvcewSYdZ9o,7037
-types_remover-1.0.0.dist-info/METADATA,sha256=UU36FTgq9Ge95bmzopuHVFy-doMIgXI5g5WK5SxNAYw,1251
-types_remover-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-types_remover-1.0.0.dist-info/licenses/LICENSE,sha256=ixuiBLtpoK3iv89l7ylKkg9rs2GzF9ukPH7ynZYzK5s,35148
-types_remover-1.0.0.dist-info/RECORD,,