plazy
Utilities for lazy Python developers
pip install plazy
Index
-
Coding
- plazy.random_string(size=6, digit=True, lower=True, upper=True)
- plazy.setattr_from_dict(obj, kv, override=True)
- @plazy.auto_assign
- @plazy.auto_assign_strict
- @plazy.cloneable
- plazy.tic(*names)
- plazy.toc(*names, default=0)
- plazy.ts2dt(ts, format="%Y/%m/%d %H:%M:%S.%f")
- plazy.dt2ts(dt, format="%Y/%m/%d %H:%M:%S.%f")
- Data
- File
PLAZY FEATURES
Coding
random_string
Plazy version: 0.1.2+
Generate random string.
plazy.random_string(
- size: length of random string. Default: 6
- digit: random string may contains digits. Default: True
- lower: random string may contains lowercases. Default: True
- upper: random string may contains uppercases. Default: True
)
import plazy
if __name__ == "__main__":
rstring = plazy.random_string() # iVr3FY
rstring = plazy.random_string(upper=False) # mzvn7b
rstring = plazy.random_string(size=8) # XqVDuu5R
rstring = plazy.random_string(size=6, digit=True, lower=False, upper=False) # 763099
rstring = plazy.random_string(size=6, digit=False, lower=True, upper=False) # djzcch
rstring = plazy.random_string(size=6, digit=False, lower=False, upper=True) # BGBMQNsetattr_from_dict
Plazy version: 0.1.4+
Dynamically set object attributes from dictionary at runtime
plazy.setattr_from_dict(
- obj: object
- kv: dictionary of new attributes. Eg: {"name": "Peter", "age": 14}
- override: override old attribute(s). Default: True
)
import plazy
# Our custom class
class Person(object):
def __init__(self, name):
self.name = name
if __name__ == "__main__":
p1 = Person(name="plazy") # init a Person object
plazy.setattr_from_dict(obj=p1, kv={
"name": "yzalp",
"age": 28,
})
print(p1.name) # "yzalp"
print(p1.age) # 28
# set "override" to False
p2 = Person(name="plazy") # init a Person object
plazy.setattr_from_dict(obj=p2,
override=False,
kv={
"name": "yzalp",
"age": 28,
})
print(p1.name) # "plazy" <- no overriding the pre-existed attribute due to "override=False"
print(p1.age) # 28auto_assign
Plazy version: 0.1.5+
Assign attributes of class with the passed arguments automatically.
@plazy.auto_assign
import plazy
class Cat(object):
@plazy.auto_assign
def __init__(self, name, owner='Kyzas'):
# no variable assignment needed
pass
def get_age(self):
return self.age if hasattr(self, "age") else None
def get_type(self):
return self.type if hasattr(self, "type") else None
if __name__ == "__main__":
mydict = {"type": "pet"}
my_cat = Cat('Kittie', age=10, **mydict) # "age" and "type" is unexpected arguments
print(my_cat.name) # Kittie
print(my_cat.owner) # Kyzas
print(my_cat.get_age()) # 10
print(my_cat.get_type()) # petauto_assign_strict
Plazy version: 0.1.5+
Assign attributes of class with the passed arguments automatically, strictly check the parameters passed to the function.
@plazy.auto_assign_strict
import plazy
class Cat(object):
@plazy.auto_assign_strict
def __init__(self, name, owner='Kyzas'):
pass
if __name__ == "__main__":
my_cat = Cat('Kittie', 'Minh')
print(my_cat.name) # Kittie
print(my_cat.owner) # Minh
his_cat = Cat('Lulu', 'Peter', 'Mary') # TypeError
her_cat = Cat('Kittie', age=10) # TypeErrorcloneable
Plazy version: 0.1.5+
Mark constructor of class as being cloneable. Method "clone" is used to clone a new instance, its arguments are the same with the constructor.
@plazy.cloneable
import plazy
class Cat(object):
@plazy.cloneable
def __init__(self, name, owner='Kyzas'):
self.name = name
self.owner = owner
pass
def get_info(self):
return {"name": self.name, "owner": self.owner}
class Dog(object):
# combine auto_assign and cloneable decorators
@plazy.cloneable
@plazy.auto_assign
def __init__(self, name, owner='Kyzas'):
pass
def get_info(self):
result = {"name": self.name, "owner": self.owner}
if hasattr(self, "age"):
result["age"] = self.age
else:
result["age"] = -1
return result
if __name__ == "__main__":
cat_template = Cat('<Cat Name>', '<Owner Name>')
his_cat = cat_template.clone('Lulu', 'Peter')
her_cat = cat_template.clone(name='Jessie')
print(his_cat.get_info()) # {'name': 'Lulu', 'owner': 'Peter'}
print(her_cat.get_info()) # {'name': 'Jessie', 'owner': '<Owner Name>'}
dog_template = Dog(name="<Dog Name>", owner="<Owner Name>", age=10) # age=10 by default
his_dog = dog_template.clone(owner='James')
her_dog = dog_template.clone(name="Husky", owner="Bella", age=5, note="Super Cute")
print(his_dog.get_info()) # {'name': '<Dog Name>', 'owner': 'James', 'age': 10}
print(her_dog.get_info()) # {'name': 'Husky', 'owner': 'Bella', 'age': 5}
print(her_dog.note) # Super Cutetic
Plazy version: 0.1.5+
Start timer
plazy.tic(
- *names: name (list)
)
import plazy
def foo():
total = 0
for _ in range(100000):
total += 1
return total
if __name__ == "__main__":
plazy.tic() # T1
plazy.tic("B") # T2
plazy.tic("C", "D", "E") # T3
foo()
dt1 = plazy.toc() # elapsed time since T1
dt2 = plazy.toc("B") # elapsed time since T2
dt3 = plazy.toc("C", "D") # elapsed time since T3
foo()
dt4 = plazy.toc("E") # elapsed time since T3
dt5 = plazy.toc("B") # elapsed time since T2
print(dt1) # 0.009924173355102539
print(dt2) # 0.009925603866577148
print(dt3) # [0.00992727279663086, 0.00992727279663086]
print(dt4) # 0.020497798919677734
print(dt5) # 0.020506620407104492toc
Plazy version: 0.1.5+
Get elapsed time(s) by name(s)
plazy.toc(
- *names: name (list)
- default: default value if name not found. Default: 0
)
import plazy
def foo():
total = 0
for _ in range(100000):
total += 1
return total
if __name__ == "__main__":
plazy.tic()
foo()
elapsed_seconds = plazy.toc() # 0.0098724365234375
elapsed_invalid = plazy.toc("B", default=-1) # -1 (name "B" does not exist, return default value)ts2dt
Plazy version: 0.1.5+
Convert timestamp to datetime string
plazy.ts2dt(
- ts: timestamp string
- format: datetime format. Default: "%Y/%m/%d %H:%M:%S.%f"
)
import time
import plazy
if __name__ == "__main__":
res = plazy.ts2dt(time.time()) # 2021/08/28 08:48:05.451271dt2ts
Plazy version: 0.1.5+
Convert datetime object / datetime string to timestamp
plazy.dt2ts(
- dt: datetime object or datetime string
- format: datetime format. Default: "%Y/%m/%d %H:%M:%S.%f"
)
import time
import plazy
if __name__ == "__main__":
res = plazy.dt2ts("2021/08/28 08:48:05.451271") # 1630140485.451271
print(res)Data
b64encode
b64decode
Plazy version: 0.1.3+
Base64 encode and decode for string.
plazy.b64encode(
- value: value to encode base64
- pretty: remove "=" character at the end after encoding. Default: False
)
plazy.b64decode(
- value: encoded base64 value to decode
)
import plazy
if __name__ == "__main__":
encoded_val = plazy.b64encode('plazy') # cGxhenk=
encoded_val = plazy.b64encode('plazy', pretty=True) # cGxhenk => Note: this string cannot be decoded!
original_val = plazy.b64decode('cGxhenk=') # plazyis_number
Plazy version: 0.1.4+
Check whether string is a number
plazy.is_number(
- s: string to check
)
import plazy
if __name__ == "__main__":
is_number = plazy.is_number("1") # True
is_number = plazy.is_number("0.234") # True
is_number = plazy.is_number("-0.234") # True
is_number = plazy.is_number("1e3") # True
is_number = plazy.is_number("plazy") # False
is_number = plazy.is_number("1.23k9") # False
is_number = plazy.is_number("x.3253254") # Falseunique
Plazy version: 0.1.3+
Turn list or tuple into unique list/tuple, keep order or sort the list/tuple.
plazy.unique(
- seq: sequence to process. Eg: [1, 3, 1, 2], (2, 5, 5, 1, 2), ...
- sort: Sort result. Default: False
- reverse: Reverse result. Default: False
)
import plazy
if __name__ == "__main__":
unique_t = plazy.unique(seq=(7, 3, 5, 3, 3, 7, 9)) # -> (7, 3, 5, 9)
unique_l = plazy.unique(seq=[7, 3, 5, 3, 3, 7, 9]) # -> [7, 3, 5, 9]
unique_rt = plazy.unique(seq=(7, 3, 5, 3, 3, 7, 9), sort=True, reverse=True) # -> (9, 7, 5, 3)File
read_txt
Plazy version: 0.1.2+, 0.1.4+
Read lines of text file, eliminate redundant characters of each line, skip the empty lines.
Read lines of text file as a list.
plazy.read_txt(
- path: path to text file
- line_func: function to process each line. Default: None
- skip_empty_line: skip empty line. Default: False
)
import plazy
if __name__ == "__main__":
lines = plazy.read_txt(path='/home/video-list.txt')
print(lines) # ['<line#1>', '<line#2>', '<line#3>', ...]
# strip every text line, remove empty line in the list:
lines = plazy.read_txt(
path='/home/video-list.txt',
line_func=lambda x : x.strip(),
skip_empty_line=True
)
# -------------------------------
# deprecated @ Plazy v0.1.2
# lines = plazy.read_txt(path='/home/video-list.txt', strip=True)
# print(lines) # ['<line#1>', '<line#2>', '<line#3>', ...]
# lines = plazy.read_txt(path='/home/video-list.txt', strip=False) # no strippingwrite_txt
Plazy version: 0.1.4+
Write text file.
plazy.write_txt(
- path: path to text file
- lines: lines to write
- mode: write mode. Default: "w"
- cat_str: concat string between lines. Default: "\n" (new line character)
)
import os
import plazy
if __name__ == "__main__":
path = '/home/plazy.txt'
lines = [
"hello",
"world",
]
plazy.write_txt(path=path, lines=lines)
assert os.path.isfile(path)list_files
Plazy version: 0.1.1+
List files recursively in directory.
plazy.list_files(
- root: directory to traverse files. Default: "./" (current directory)
- filter_func: filter function to apply. Default: None
- is_include_root: include root directory path in the result. Default: False
)
import plazy
if __name__ == "__main__":
files = plazy.list_files(root='images',
filter_func=lambda x : True if x.endswith('.jpg') else False,
is_include_root=False)
print(files) # ['1.jpg', '2.jpg', '_sub_/4.jpg']CONTRIBUTING
- Step 1. Fork on dev branch.
- Step 2. Install pre-commit on the local dev environment.
pip install pre-commit
pre-commit install
- Step 3. Write test case(s) for the new feature or the bug.
- Step 4. Write code to pass the tests.
- Step 5. Make sure that the new code passes all the pre-commmit conditions.
pre-commit run -a
- Step 6. Create pull request.
