modkit 0.1.0

A package to manage your python modules.

modkit

A package to manage your python modules

Install

# released version
pip install modkit
# latest version
pip intall git+https://github.com/pwwanbg/modkit

Usage

Allowing specific names to be imported, even with from ... import *

mymodule.py:

from modkit import Modkit
modkit = Modkit()
modkit.exports('a', 'b')
# Now you can specify glob patterns for exports via 0.1.0
# modkit.exports('p*') # works with dynamic exports
a = 1
b = 2
c = 3

Try to import this module:

import mymodule as mm
mm.a # 1
mm.b # 2
mm.c # NameNotImportable

from mymodule import *
a # 1
b # 2
c # NameError

# NameNotImportable
from mymodule import c

Banning certain names

mymodule.py:

from modkit import Modkit
modkit = Modkit()
modkit.ban('a')
a = 1

import mymodule as mm
mm.a # NameBannedFromImport

# NameBannedFromImport
from mymodule import a

Aliasing names

mymodule.py:

from modkit import Modkit
modkit = Modkit()
modkit.alias('some_internal_wired_name', 'a')
some_internal_wired_name = 1

from mymodule import a
a # 1

Importing names dynamically

mymodule.py:

from modkit import Modkit
modkit = Modkit()

def delegate(name):
	if name == 'a':
		return 1
	if name == 'b':
		return 2
	if name == 'c':
		return lambda: 3

modkit.delegate(delegate)

from mymodule import a, b, c
a # 1
b # 2
c() # 3

# NameBannedFromImport
from mymodule import delegate

# if you want to reuse it
# mymodule.modkit.unban('delegate')

modkit has reserved delegate function with name _modkit_delegate. With this function defined in your module, you won't have to call modkit.delegate

mymodule.py

import modkit
modkit.Modkit()

def _modkit_delegate(name):
	if name == 'a':
		return 1
	if name == 'b':
		return 2
	if name == 'c':
		return lambda: 3

# nothing needs to do

Then you are able to import a, b and c from mymodule:

from mymodule import a, b, c

Generating a new module based on current one

mymodule.py

import modkit
modkit.Modkit()

A = 1
def _modkit_call(module, a):
	setattr(module, 'A', 2)
	return module

import mymodule
A # 1
mymodule2 = mymodule(2)
mymodule2.A # 2
from mymodule2 import A
A # 2
from mymodule import A
A # 1