Question about RFT mode

[himkt]

Background

I'm now trying to obfuscate the package (mypkg) with the RFT mode.

1. I am creating an unpacked package with python -m build --wheel + python -m wheel unpack.
2. Then obfuscateit with pyarmor gen --enable-bcc -i -r path/to/mypkg

(I am using hatching to build the package and therefore not following https://pyarmor.readthedocs.io/en/latest/how-to/wheel.html).

What I'm now struggling

I got the following RFT trace logs:

trace.rft            mypkg.mod1.mod2:4 (from typing import TYPE_CHECKING as pyarmor__48)
trace.rft            mypkg.mod1.mod2:9 (from third_party_pkg1 import Cls1 as pyarmor__51)
trace.rft            mypkg.mod1.mod2:11 (TYPE_CHECKING->pyarmor__48)
trace.rft            mypkg.mod1.mod2:14 (import third_party_pkg2 as pyarmor__5)

However, in mod2, Cls2 is also imported from another module mod3.mod4 inside mypkg. This import renaming is skipped.
When I renamed path/to/package to path/to/tmp and executed pyarmor gen --enable-bcc -i -r path/to/tmp, the previously skipped renaming of Cls2 was performed. So, I think the package name has some special power...

trace.rft            tmp.mypkg.mod1.mod2:4 (from typing import TYPE_CHECKING as pyarmor__48)
trace.rft            tmp.mypkg.mod1.mod2:9 (from third_party_pkg1 import Cls1 as pyarmor__51)
trace.rft            tmp.mypkg.mod1.mod2:11 (TYPE_CHECKING->pyarmor__48)
trace.rft            tmp.mypkg.mod1.mod2:12 (from mypkg.mod3.mod4 import Cl2 as pyarmor__52)
trace.rft            tmp.mypkg.mod1.mod2:14 (import third_party_pkg2 as pyarmor__5)

I just went through the documentation, but I'm not sure why from mypkg.mod3.mod4 import Cl2 is not renamed.

What does RFT mode not change?
* argument in function definition                         => No, Cls2 is class.
* keyword argument name in call                           => No, Cls2 is class.
* all the strings defined in the module attribute __all__ => No, Cls2 is not included in any `__all__` in mypkg.
* all the name starts with __                             => No, Cls2 starts with a uppercase.

From "https://pyarmor.readthedocs.io/en/latest/topic/rftmode.html#insight-into-rft-mode".

I want to know the reason why import name is not renamed if that is imported from mypkg itself.

[jondy]

In auto-exclude mode, if pyarmor don't know the type of variable a, and there is attribute chain a.b.c, the name b won't be renamed
If you start to RFT mode now, I recommend using pyarmor 9.1 new features, pyarmor build --rft, please refer to
https://eke.dashingsoft.com/pyarmor/docs/en/index.html

[himkt]

Thank you so much @jondy! I just tried to use pyarmor build cmd.

...Sorry for bothering you but I still have questions...

Initialize

I initialize the environment.

pyarmor init --clean -p mypkg

I confirmed that package is correctly tracked (I think).

> pyarmor build --list
INFO     Python 3.9.6
INFO     Pyarmor 9.1.2 (trial), 000000, non-profits
INFO     Platform darwin.aarch64
INFO     load project ...
INFO     load 0 scripts
INFO     load 0 modules
INFO     load 1 packages
INFO     load project end
INFO     project src: .
INFO     project scripts:
INFO     project modules:
INFO     project packages:
INFO       mypkg
INFO         mypkg/__init__.py
INFO         mypkg/mod/__init__.py
INFO         mypkg/mod/fn.py

Build

And running pyarmor build (I just ran the command on the local environment to test).

> pyarmor build --mini
INFO     Python 3.9.6
INFO     Pyarmor 9.1.2 (trial), 000000, non-profits
INFO     Platform darwin.aarch64
INFO     load project ...
INFO     load 0 scripts
INFO     load 0 modules
INFO     load 1 packages
INFO     load project end
INFO     build target mini ...
WARNING  all rft features are disabled
...
INFO     build target mini end

update; I just ran pyarmor build --rft with the actual package I want to obfuscate as well on CI to get the error ERROR maximum recursion depth exceeded in __instancecheck__.

Result and question

And I got the following distribution.

> tree dist
dist
├── mypkg
│   ├── mod
│   │   └── fn.py
│   ├── mod.py
└── mypkg.py

I want to ask further questions.

1. why __init__.py is not included?
2. what is mypkg/mod.py?
3. what is mypkg.py?

I just assumed that the same files as tracked in pyarmor build --list would be created under the dist.

# This is tracked files,
INFO       mypkg
INFO         mypkg/__init__.py
INFO         mypkg/mod/__init__.py
INFO         mypkg/mod/fn.py
# So, I assumed `dist/` would be
mypkg
  mypkg/__init__.py
  mypkg/mod/__init__.py
  mypkg/mod/fn.py
# with obfuscation.

---

Just a note; I think pyarmor build --rst in "3.2. Generate RFT Script" is a typo of pyarmor build --rft.

https://eke.dashingsoft.com/pyarmor/docs/en/user/tutorials.html#generate-rft-script

[jondy]

Thanks, I have fixed typos for --rst

Regarding to __init__.py, it's one bug.

This will be fixed in next release, pre-release is available here
https://pyarmor.dashingsoft.com/downloads/temp/pyarmor-9.1.2.tar.gz

[himkt]

I confirmed that __init__.py is now created, thank you!

Now a tree of dist:

> tree dist
dist
├── mypkg
│   ├── __init__.py
│   ├── mod
│   │   └── __init__.py
│   │   └── fn.py
|   └── mod.py
└── mypkg.py

How should I take mypkg.py on dist/ and mod.py on dist/mypkg/? There are no corresponding files on the original mypkg codebase. They are needed to be bundled in the obfuscated package?

And also, I noticed there is no pyarmor_runtime.so in the distribution. That is no more needed for the new style interface?

(Sorry for asking a bunch of questions, please just reply "see the documentation" if that is already explained)

[jondy]

Remove dist and build again, see tutorilas for using RFT / Mini scripts

[himkt]

I just built that again and confirmed now files are aligned with the original package!
I'm happy to wait the next release of PyArmor.

I'll read the documentation more carefully to understand pyarmor_runtime.so related.
Thank you so much!