Skip to content

Commit 070a8fd

Browse files
authored
Update README.md
1 parent 5639458 commit 070a8fd

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ This is a Python script that obfuscates Python code by renaming variables and fu
77

88
- **Customizable obfuscation**: Specify the length of obfuscated names.
99
- **Automatic detection**: Detects and skips obfuscation for built-in names, imported modules, and essential functions. (almost always)
10+
- **String safety**: Leaves string literals and comments untouched to avoid breaking code functionality.
1011
- **Output to a new file**: Saves the obfuscated code in a separate file, leaving the original file untouched.
1112

1213
## Requirements
@@ -42,7 +43,8 @@ This will read the file `example.py`, obfuscate it with randomized names of leng
4243
- Names listed in the `NO_OBFUSCATE` set.
4344
3. **Generate random names**: Uses the `random` module to generate randomized names of the specified length.
4445
4. **Replace names**: Substitutes the original names with the randomized names while ensuring the code remains functional.
45-
5. **Save the output**: Writes the obfuscated code to the specified output file.
46+
5. **Token safety**: Leaves string literals, comments, and other tokens untouched to preserve readability in necessary areas.
47+
6. **Save the output**: Writes the obfuscated code to the specified output file.
4648

4749
## Limitations
4850

0 commit comments

Comments
 (0)