add: format to output

Author: deoktr

MANIFEST.in

@@ -1,5 +1,6 @@
 recursive-include pof *.py
 include pof/utils/generator/names.txt
+include pof/utils/generator/comments.txt
 include pof/utils/se/homoglyphs.txt
 
 recursive-include tests *

README.md

@@ -571,6 +571,22 @@ The `out2.py` and `out3.py` files are identical, they both contain the source co
 > [!NOTE]
 > By default pof uses a custom `Untokenizer` that removes useless spaces (`NoSpaceUntokenizer` defined in `./pof/utils/tokens.py`), so first generation (in the example `out.py`) will not have spaces present in the subsquent outputs.
 
+### Format
+
+You can choose to automatically format the output code using black.
+
+From the CLI add the `--format` flag.
+
+From lib:
+
+```py
+from pof.utils.format import black_format
+
+obf = ExampleObfuscator().obfuscate(...)
+out = black_format(obf)
+print(out)
+```
+
 ### Generators
 
 Generators are used to generate new names, they can be used to classes, variables, functions, constants or any other.

pof/cli.py

@@ -27,6 +27,7 @@
 from pof.obfuscator import __all__ as all_obfuscator
 from pof.stager import *  # noqa: F403
 from pof.stager import __all__ as all_stager
+from pof.utils.format import black_format
 
 handler = logging.StreamHandler()
 formatter = logging.Formatter("%(levelname)s %(message)s\x1b[39m")
@@ -137,6 +138,9 @@ def _handle(args) -> int:
 
     end = time.time()
 
+    if args.format:
+        out = black_format(out)
+
     time_diff = round(end - start, 4)
     logging.info(f"took: {time_diff}s")
     args.output.write(out)
@@ -175,6 +179,11 @@ def _cli() -> int:
         help="obfuscation function",
         default="obfuscate",
     )
+    parser.add_argument(
+        "--format",
+        action="store_true",
+        help="format output with black",
+    )
     parser.add_argument(
         "--logging",
         help="logging level, DEBUG, INFO, ERROR, CRITICAL",

pof/cli_v2.py

@@ -26,6 +26,7 @@
 from pof.evasion import *  # noqa: F403
 from pof.obfuscator import *  # noqa: F403
 from pof.stager import *  # noqa: F403
+from pof.utils.format import black_format
 
 handler = logging.StreamHandler()
 formatter = logging.Formatter("%(levelname)s %(message)s\x1b[39m")
@@ -344,6 +345,9 @@ def _handle(args) -> int:
 
     end = time.time()
 
+    if args.format_black:
+        out = black_format(out)
+
     time_diff = round(end - start, 4)
     logging.info("took: %ds", time_diff)
     args.output.write(out)
@@ -468,6 +472,11 @@ def _cli() -> int:
     parser.add_argument("--eva-uptime", action="store_true")
     parser.add_argument("--eva-utc", action="store_true")
 
+    # format
+    parser.add_argument(
+        "--format-black", action="store_true", help="format output with black"
+    )
+
     # control
     parser.add_argument(
         "--obf-count",

pof/main.py

@@ -65,7 +65,7 @@
 class BaseObfuscator:
     @staticmethod
     def _get_tokens(source: str):
-        # TODO: this is not safe, the \r could be inside a string, probably
+        # TODO (deoktr): this is not safe, the \r could be inside a string, probably
         # should get tokens first, and update all the instances of newline
         if "\r" in source:
             source = source.replace("\r\n", "\n").replace("\r", "\n")

pof/utils/format.py

@@ -0,0 +1,35 @@
+# POF, a free and open source Python obfuscation framework.
+# Copyright (C) 2022 - 2025  POF Team
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+
+import logging
+
+try:
+    import black
+
+    BLACK_INSTALLED = True
+except ImportError:
+    BLACK_INSTALLED = False
+
+from pof.errors import PofError
+
+
+def black_format(src: str) -> str:
+    """Format raw source code using black."""
+    if not BLACK_INSTALLED:
+        logging.error("'black' is not installed, cannot format using it")
+        return src
+    return black.format_str(src, mode=black.FileMode())

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-obfuscation-framework"
-version = "1.6.3"
+version = "1.7.0"
 description = "Python Obfuscation Framework"
 readme = "README.md"
 requires-python = ">=3.5"
@@ -32,6 +32,7 @@ classifiers = [
 dependencies = [
   "rope>=1.0.0",
   "Pillow>=10.0.0",
+  "black>=24.10.0",
 ]
 # dynamic = ["version"]
 

server/pyproject.toml

@@ -30,6 +30,7 @@ dependencies = [
   "pygments>=2.19.2",
   "python-obfuscation-framework>=1.7.0",
   "gunicorn>=23.0.0",
+  "black==24.10.0",
 ]
 
 [project.optional-dependencies]