# carefree-toolkit
`carefree-toolkit` implemented some commonly used functions and modules
## Installation
`carefree-toolkit` requires Python 3.8 or higher.
```bash
pip install carefree-toolkit
```
or
```bash
git clone https://github.com/carefree0910/carefree-toolkit.git
cd carefree-toolkit
pip install -e .
```
## Usages
### **`timeit`**
```python
class timeit(context_error_handler):
def __init__(self, msg)
```
Timing context manager.
#### Parameters
+ **`msg`** : **str**, name of the context which we want to timeit.
#### Example
```python
import time
from cftool.misc import timeit
# ~~~ [ info ] timing for sleep 1s : 1.0002
with timeit("sleep 1s"):
time.sleep(1)
```
### **`timestamp`**
```python
def timestamp(simplify=False, ensure_different=False) -> str
```
Return current timestamp.
#### Parameters
+ **`simplify`** : **bool**. If `True`, format will be simplified to 'year-month-day'.
+ **`ensure_different`** : **bool**. If `True`, format will include millisecond.
#### Example
```python
from cftool.misc import timestamp
# 2019-09-30_21-49-56
print(timestamp())
# 2019-09-30
print(timestamp(simplify=True))
# 2019-09-30_21-49-56-279768
print(timestamp(ensure_different=True))
```
### **`prod`**
```python
def prod(iterable) -> float
```
Return cumulative production of an **`iterable`**.
#### Parameters
+ **`iterable`** : **iterable**.
#### Example
```python
from cftool.misc import prod
# 120.0
print(prod(range(1, 6)))
```
### **`hash_code`**
```python
def hash_code(code) -> str
```
Return hash code for string **`code`**.
#### Parameters
+ **`code`** : **str**.
#### Example
```python
from cftool.misc import hash_code
# True
hash_code("a") != hash_code("b")
```
### **`prefix_dict`**
```python
def prefix_dict(d, prefix) -> dict
```
Prefix every key in dict **`d`** with **`prefix`**, connected with `'_'`.
#### Parameters
+ **`d`** : **dict**.
+ **`prefix`** : **str**.
#### Example
```python
from cftool.misc import prefix_dict
# {"foo_a": 1, "foo_b": 2}
print(prefix_dict({"a": 1, "b": 2}, "foo"))
```
### **`shallow_copy_dict`**
```python
def shallow_copy_dict(d) -> dict
```
Shallow copy dict **`d`**, nested dict is also supported.
#### Parameters
+ **`d`** : **dict**.
#### Example
```python
from cftool.misc import shallow_copy_dict
d = {"a": 1, "b": {"c": 2, "d": 3}}
sd = shallow_copy_dict(d)
d_copy = d.copy()
d["b"].pop("c")
# {'a': 1, 'b': {'d': 3}}
print(d)
# {'a': 1, 'b': {'c': 2, 'd': 3}}
print(sd)
# {'a': 1, 'b': {'d': 3}}
print(d_copy)
```
### **`update_dict`**
```python
def update_dict(src_dict, tgt_dict) -> dict
```
Update **`tgt_dict`** with **`src_dict`**.
> Changes will happen only on keys which **`src_dict`** holds, and the update procedure will be recursive.
> Changed will happen inplace.
#### Parameters
+ **`src_dict`** : **dict**.
+ **`tgt_dict`** : **str**.
#### Example
```python
from cftool.misc import update_dict
src_dict = {"a": {"b": 1}, "c": 2}
tgt_dict = {"a": {"b": 0, "b1": 1}, "c": 0, "d": 1}
# {"a": {"b": 1, "b1": 1}, "c": 2, "d": 1}
print(update_dict(src_dict, tgt_dict))
```
### **`fix_float_to_length`**
```python
def fix_float_to_length(num, length) -> str
```
Change a float number to string format with fixed length.
#### Parameters
+ **`num`** : **float**.
+ **`length`** : **int**.
#### Example
```python
import math
from cftool.misc import fix_float_to_length
# 1.000000
print(fix_float_to_length(1, 8))
# 1.000000
print(fix_float_to_length(1., 8))
# 1.000000
print(fix_float_to_length(1.0, 8))
# -1.00000
print(fix_float_to_length(-1, 8))
# -1.00000
print(fix_float_to_length(-1., 8))
# -1.00000
print(fix_float_to_length(-1.0, 8))
# 1234567.
print(fix_float_to_length(1234567, 8))
# 12345678
print(fix_float_to_length(12345678, 8))
# 123456789
print(fix_float_to_length(123456789, 8))
# + nan +
print("+" + fix_float_to_length(math.nan, 8) + "+")
```
### **`truncate_string_to_length`**
```python
def truncate_string_to_length(string, length) -> str
```
Truncate a string to make sure its length not exceeding a given length.
#### Parameters
+ **`string`** : **str**.
+ **`length`** : **int**.
#### Example
```python
from cftool.misc import truncate_string_to_length
# 123456
print(truncate_string_to_length("123456", 6))
# 12..67
print(truncate_string_to_length("1234567", 6))
# 12..78
print(truncate_string_to_length("12345678", 6))
# 12...78
print(truncate_string_to_length("12345678", 7))
```
### **`grouped`**
```python
def grouped(iterable, n, *, keep_tail) -> list
```
Group an **`iterable`** every **`n`** elements.
#### Parameters
+ **`iterable`** : **iterable**.
+ **`n`** : **int**.
+ **`keep_tail`** : **bool**, whether keep the 'tail' (see example below).
#### Example
```python
from cftool.misc import grouped
# [(0, 1), (2, 3), (4, 5)]
print(grouped(range(6), 2))
# [(0, 1, 2), (3, 4, 5)]
print(grouped(range(6), 3))
# [(0, 1, 2, 3)]
print(grouped(range(6), 4))
# [(0, 1, 2, 3), (4, 5)]
print(grouped(range(6), 4, keep_tail=True))
```
### **`is_number`**
```python
def is_numeric(s) -> bool
```
Check whether string **`s`** is numeric.
#### Parameters
+ **`s`** : **str**.
#### Example
```python
from cftool.misc import is_numeric
# True
print(is_numeric(0x1))
# True
print(is_numeric(1e0))
# True
print(is_numeric("1"))
# True
print(is_numeric("1."))
# True
print(is_numeric("1.0"))
# True
print(is_numeric("1.00"))
# False
print(is_numeric("1.0.0"))
# True
print(is_numeric("nan"))
```
### **`get_one_hot`**
```python
def get_one_hot(feature, dim) -> np.ndarray
```
Get one-hot representation.
#### Parameters
+ **`feature`** : **array-like**, source data of one-hot representation.
+ **`dim`** : **int**, dimension of the one-hot representation.
#### Example
```python
import numpy as np
from cftool.array import get_one_hot
feature = np.array([0, 1, 0])
# [[1 0], [0 1], [1 0]]
print(get_one_hot(feature, 2))
# [[1 0 0] [0 1 0] [1 0 0]]
print(get_one_hot(feature, 3))
# [[1 0 0] [0 1 0] [1 0 0]]
print(get_one_hot(feature.tolist(), 3))
```
### **`get_indices_from_another`**
```python
def get_indices_from_another(base, segment) -> np.ndarray
```
Get **`segment`** elements' indices in **`base`**. This function will return positions where elements in **`segment`** appear in **`base`**.
> All elements in segment should appear in base to ensure validity.
#### Parameters
+ **`base`** : **np.ndarray**, base array.
+ **`segment`** : **np.ndarray**, segment array.
#### Example
```python
import numpy as np
from cftool.array import get_indices_from_another
base, segment = np.array([1, 2, 3, 5, 7, 8, 9]), np.array([1, 3, 5, 7, 9])
# [0 2 3 4 6]
print(get_indices_from_another(base, segment))
# [0 1 2 3 4]
print(get_indices_from_another(segment, segment))
# [4 3 2 1 0]
print(get_indices_from_another(segment[::-1], segment))
```
### **`get_unique_indices`**
```python
def get_unique_indices(arr) -> UniqueIndices
```
Get indices for unique values of an array.
#### Parameters
+ **`arr`** : **np.ndarray**, target array which we wish to find indices of each unique value.
+ **`return_raw`** : **bool**, whether returning raw information.
#### Example
```python
import numpy as np
from cftool.array import get_unique_indices
arr = np.array([1, 2, 3, 2, 4, 1, 0, 1], np.int64)
unique_indices = get_unique_indices(arr)
# UniqueIndices(
# unique = array([0, 1, 2, 3, 4], dtype=int64),
# unique_cnt = array([1, 3, 2, 1, 1], dtype=int64),
# sorting_indices = array([6, 0, 5, 7, 1, 3, 2, 4], dtype=int64),
# split_arr = array([1, 4, 6, 7], dtype=int64))
# split_indices = [array([6], dtype=int64), array([0, 5, 7], dtype=int64), array([1, 3], dtype=int64),
# array([2], dtype=int64), array([4], dtype=int64)]
print(get_unique_indices(arr))
```
### And more...
`carefree-toolkit` is well documented, feel free to dive into the codes and explore something you may need!
## License
`carefree-toolkit` is MIT licensed, as found in the [`LICENSE`](https://github.com/carefree0910/carefree-toolkit/blob/master/LICENSE) file.
---
Raw data
{
"_id": null,
"home_page": "https://github.com/carefree0910/carefree-toolkit",
"name": "carefree-toolkit",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "python numpy data-science",
"author": "carefree0910",
"author_email": "syameimaru.saki@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7b/7a/3c3bd978690c71ecadee7d0e4b23d49cbb10963323080f1dce68651551f7/carefree-toolkit-0.3.12.tar.gz",
"platform": null,
"description": "# carefree-toolkit\r\n\r\n`carefree-toolkit` implemented some commonly used functions and modules\r\n\r\n\r\n## Installation\r\n\r\n`carefree-toolkit` requires Python 3.8 or higher.\r\n\r\n```bash\r\npip install carefree-toolkit\r\n```\r\n\r\nor\r\n\r\n```bash\r\ngit clone https://github.com/carefree0910/carefree-toolkit.git\r\ncd carefree-toolkit\r\npip install -e .\r\n```\r\n\r\n\r\n## Usages\r\n\r\n### **`timeit`**\r\n\r\n```python\r\nclass timeit(context_error_handler):\r\n def __init__(self, msg)\r\n```\r\n\r\nTiming context manager.\r\n\r\n#### Parameters\r\n\r\n+ **`msg`** : **str**, name of the context which we want to timeit.\r\n\r\n#### Example\r\n\r\n```python\r\nimport time\r\nfrom cftool.misc import timeit\r\n\r\n# ~~~ [ info ] timing for sleep 1s : 1.0002\r\nwith timeit(\"sleep 1s\"):\r\n time.sleep(1)\r\n```\r\n\r\n\r\n### **`timestamp`**\r\n\r\n```python\r\ndef timestamp(simplify=False, ensure_different=False) -> str\r\n```\r\n\r\nReturn current timestamp.\r\n\r\n#### Parameters\r\n\r\n+ **`simplify`** : **bool**. If `True`, format will be simplified to 'year-month-day'.\r\n+ **`ensure_different`** : **bool**. If `True`, format will include millisecond.\r\n\r\n#### Example\r\n\r\n```python\r\nfrom cftool.misc import timestamp\r\n\r\n# 2019-09-30_21-49-56\r\nprint(timestamp())\r\n# 2019-09-30\r\nprint(timestamp(simplify=True))\r\n# 2019-09-30_21-49-56-279768\r\nprint(timestamp(ensure_different=True))\r\n```\r\n\r\n\r\n### **`prod`**\r\n\r\n```python\r\ndef prod(iterable) -> float\r\n```\r\n\r\nReturn cumulative production of an **`iterable`**.\r\n\r\n#### Parameters\r\n\r\n+ **`iterable`** : **iterable**.\r\n\r\n#### Example\r\n\r\n```python\r\nfrom cftool.misc import prod\r\n\r\n# 120.0\r\nprint(prod(range(1, 6)))\r\n```\r\n\r\n\r\n### **`hash_code`**\r\n\r\n```python\r\ndef hash_code(code) -> str\r\n```\r\n\r\nReturn hash code for string **`code`**.\r\n\r\n#### Parameters\r\n\r\n+ **`code`** : **str**.\r\n\r\n#### Example\r\n\r\n```python\r\nfrom cftool.misc import hash_code\r\n\r\n# True\r\nhash_code(\"a\") != hash_code(\"b\")\r\n```\r\n\r\n\r\n### **`prefix_dict`**\r\n\r\n```python\r\ndef prefix_dict(d, prefix) -> dict\r\n```\r\n\r\nPrefix every key in dict **`d`** with **`prefix`**, connected with `'_'`.\r\n\r\n#### Parameters\r\n\r\n+ **`d`** : **dict**.\r\n+ **`prefix`** : **str**.\r\n\r\n#### Example\r\n\r\n```python\r\nfrom cftool.misc import prefix_dict\r\n\r\n# {\"foo_a\": 1, \"foo_b\": 2}\r\nprint(prefix_dict({\"a\": 1, \"b\": 2}, \"foo\"))\r\n```\r\n\r\n\r\n### **`shallow_copy_dict`**\r\n\r\n```python\r\ndef shallow_copy_dict(d) -> dict\r\n```\r\n\r\nShallow copy dict **`d`**, nested dict is also supported.\r\n\r\n#### Parameters\r\n\r\n+ **`d`** : **dict**.\r\n\r\n#### Example\r\n\r\n```python\r\nfrom cftool.misc import shallow_copy_dict\r\n\r\nd = {\"a\": 1, \"b\": {\"c\": 2, \"d\": 3}}\r\nsd = shallow_copy_dict(d)\r\nd_copy = d.copy()\r\nd[\"b\"].pop(\"c\")\r\n# {'a': 1, 'b': {'d': 3}}\r\nprint(d)\r\n# {'a': 1, 'b': {'c': 2, 'd': 3}}\r\nprint(sd)\r\n# {'a': 1, 'b': {'d': 3}}\r\nprint(d_copy)\r\n```\r\n\r\n\r\n### **`update_dict`**\r\n\r\n```python\r\ndef update_dict(src_dict, tgt_dict) -> dict\r\n```\r\n\r\nUpdate **`tgt_dict`** with **`src_dict`**.\r\n\r\n> Changes will happen only on keys which **`src_dict`** holds, and the update procedure will be recursive.\r\n\r\n> Changed will happen inplace.\r\n\r\n#### Parameters\r\n\r\n+ **`src_dict`** : **dict**.\r\n+ **`tgt_dict`** : **str**.\r\n\r\n#### Example\r\n\r\n```python\r\nfrom cftool.misc import update_dict\r\n\r\nsrc_dict = {\"a\": {\"b\": 1}, \"c\": 2}\r\ntgt_dict = {\"a\": {\"b\": 0, \"b1\": 1}, \"c\": 0, \"d\": 1}\r\n# {\"a\": {\"b\": 1, \"b1\": 1}, \"c\": 2, \"d\": 1}\r\nprint(update_dict(src_dict, tgt_dict))\r\n```\r\n\r\n\r\n### **`fix_float_to_length`**\r\n\r\n```python\r\ndef fix_float_to_length(num, length) -> str\r\n```\r\n\r\nChange a float number to string format with fixed length.\r\n\r\n#### Parameters\r\n\r\n+ **`num`** : **float**.\r\n+ **`length`** : **int**.\r\n\r\n#### Example\r\n\r\n```python\r\nimport math\r\nfrom cftool.misc import fix_float_to_length\r\n\r\n# 1.000000\r\nprint(fix_float_to_length(1, 8))\r\n# 1.000000\r\nprint(fix_float_to_length(1., 8))\r\n# 1.000000\r\nprint(fix_float_to_length(1.0, 8))\r\n# -1.00000\r\nprint(fix_float_to_length(-1, 8))\r\n# -1.00000\r\nprint(fix_float_to_length(-1., 8))\r\n# -1.00000\r\nprint(fix_float_to_length(-1.0, 8))\r\n# 1234567.\r\nprint(fix_float_to_length(1234567, 8))\r\n# 12345678\r\nprint(fix_float_to_length(12345678, 8))\r\n# 123456789\r\nprint(fix_float_to_length(123456789, 8))\r\n# + nan +\r\nprint(\"+\" + fix_float_to_length(math.nan, 8) + \"+\")\r\n```\r\n\r\n\r\n### **`truncate_string_to_length`**\r\n\r\n```python\r\ndef truncate_string_to_length(string, length) -> str\r\n```\r\n\r\nTruncate a string to make sure its length not exceeding a given length.\r\n\r\n#### Parameters\r\n\r\n+ **`string`** : **str**.\r\n+ **`length`** : **int**.\r\n\r\n#### Example\r\n\r\n```python\r\nfrom cftool.misc import truncate_string_to_length\r\n\r\n# 123456\r\nprint(truncate_string_to_length(\"123456\", 6))\r\n# 12..67\r\nprint(truncate_string_to_length(\"1234567\", 6))\r\n# 12..78\r\nprint(truncate_string_to_length(\"12345678\", 6))\r\n# 12...78\r\nprint(truncate_string_to_length(\"12345678\", 7))\r\n```\r\n\r\n\r\n### **`grouped`**\r\n\r\n```python\r\ndef grouped(iterable, n, *, keep_tail) -> list\r\n```\r\n\r\nGroup an **`iterable`** every **`n`** elements.\r\n\r\n#### Parameters\r\n\r\n+ **`iterable`** : **iterable**.\r\n+ **`n`** : **int**.\r\n+ **`keep_tail`** : **bool**, whether keep the 'tail' (see example below).\r\n\r\n#### Example\r\n\r\n```python\r\nfrom cftool.misc import grouped\r\n\r\n# [(0, 1), (2, 3), (4, 5)]\r\nprint(grouped(range(6), 2))\r\n# [(0, 1, 2), (3, 4, 5)]\r\nprint(grouped(range(6), 3))\r\n# [(0, 1, 2, 3)]\r\nprint(grouped(range(6), 4))\r\n# [(0, 1, 2, 3), (4, 5)]\r\nprint(grouped(range(6), 4, keep_tail=True))\r\n```\r\n\r\n\r\n### **`is_number`**\r\n\r\n```python\r\ndef is_numeric(s) -> bool\r\n```\r\n\r\nCheck whether string **`s`** is numeric.\r\n\r\n#### Parameters\r\n\r\n+ **`s`** : **str**.\r\n\r\n#### Example\r\n\r\n```python\r\nfrom cftool.misc import is_numeric\r\n\r\n# True\r\nprint(is_numeric(0x1))\r\n# True\r\nprint(is_numeric(1e0))\r\n# True\r\nprint(is_numeric(\"1\"))\r\n# True\r\nprint(is_numeric(\"1.\"))\r\n# True\r\nprint(is_numeric(\"1.0\"))\r\n# True\r\nprint(is_numeric(\"1.00\"))\r\n# False\r\nprint(is_numeric(\"1.0.0\"))\r\n# True\r\nprint(is_numeric(\"nan\"))\r\n```\r\n\r\n\r\n### **`get_one_hot`**\r\n\r\n```python\r\ndef get_one_hot(feature, dim) -> np.ndarray\r\n```\r\n\r\nGet one-hot representation.\r\n\r\n#### Parameters\r\n\r\n+ **`feature`** : **array-like**, source data of one-hot representation.\r\n+ **`dim`** : **int**, dimension of the one-hot representation. \r\n\r\n#### Example\r\n\r\n```python\r\nimport numpy as np\r\nfrom cftool.array import get_one_hot\r\n\r\nfeature = np.array([0, 1, 0])\r\n# [[1 0], [0 1], [1 0]]\r\nprint(get_one_hot(feature, 2))\r\n# [[1 0 0] [0 1 0] [1 0 0]]\r\nprint(get_one_hot(feature, 3))\r\n# [[1 0 0] [0 1 0] [1 0 0]]\r\nprint(get_one_hot(feature.tolist(), 3))\r\n```\r\n\r\n\r\n### **`get_indices_from_another`**\r\n\r\n```python\r\ndef get_indices_from_another(base, segment) -> np.ndarray\r\n```\r\n\r\nGet **`segment`** elements' indices in **`base`**. This function will return positions where elements in **`segment`** appear in **`base`**.\r\n\r\n> All elements in segment should appear in base to ensure validity.\r\n\r\n#### Parameters\r\n\r\n+ **`base`** : **np.ndarray**, base array.\r\n+ **`segment`** : **np.ndarray**, segment array. \r\n\r\n#### Example\r\n\r\n```python\r\nimport numpy as np\r\nfrom cftool.array import get_indices_from_another\r\n\r\nbase, segment = np.array([1, 2, 3, 5, 7, 8, 9]), np.array([1, 3, 5, 7, 9])\r\n# [0 2 3 4 6]\r\nprint(get_indices_from_another(base, segment))\r\n# [0 1 2 3 4]\r\nprint(get_indices_from_another(segment, segment))\r\n# [4 3 2 1 0]\r\nprint(get_indices_from_another(segment[::-1], segment))\r\n```\r\n\r\n\r\n### **`get_unique_indices`**\r\n\r\n```python\r\ndef get_unique_indices(arr) -> UniqueIndices\r\n```\r\n\r\n Get indices for unique values of an array.\r\n\r\n#### Parameters\r\n\r\n+ **`arr`** : **np.ndarray**, target array which we wish to find indices of each unique value.\r\n+ **`return_raw`** : **bool**, whether returning raw information.\r\n\r\n#### Example\r\n\r\n```python\r\nimport numpy as np\r\nfrom cftool.array import get_unique_indices\r\n\r\narr = np.array([1, 2, 3, 2, 4, 1, 0, 1], np.int64)\r\nunique_indices = get_unique_indices(arr)\r\n# UniqueIndices(\r\n# unique = array([0, 1, 2, 3, 4], dtype=int64),\r\n# unique_cnt = array([1, 3, 2, 1, 1], dtype=int64),\r\n# sorting_indices = array([6, 0, 5, 7, 1, 3, 2, 4], dtype=int64),\r\n# split_arr = array([1, 4, 6, 7], dtype=int64))\r\n# split_indices = [array([6], dtype=int64), array([0, 5, 7], dtype=int64), array([1, 3], dtype=int64),\r\n# array([2], dtype=int64), array([4], dtype=int64)]\r\nprint(get_unique_indices(arr))\r\n```\r\n\r\n\r\n### And more...\r\n\r\n`carefree-toolkit` is well documented, feel free to dive into the codes and explore something you may need!\r\n\r\n\r\n## License\r\n\r\n`carefree-toolkit` is MIT licensed, as found in the [`LICENSE`](https://github.com/carefree0910/carefree-toolkit/blob/master/LICENSE) file.\r\n\r\n---\r\n",
"bugtrack_url": null,
"license": "",
"summary": "Some commonly used functions and modules",
"version": "0.3.12",
"project_urls": {
"Download": "https://github.com/carefree0910/carefree-toolkit/archive/v0.3.12.tar.gz",
"Homepage": "https://github.com/carefree0910/carefree-toolkit"
},
"split_keywords": [
"python",
"numpy",
"data-science"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b7a3c3bd978690c71ecadee7d0e4b23d49cbb10963323080f1dce68651551f7",
"md5": "e95d8ac5ee73adf79fae1656ee27579c",
"sha256": "642a32343f261184c77c8b90585cb550869e7119ff67a1535e911f3b7a944e12"
},
"downloads": -1,
"filename": "carefree-toolkit-0.3.12.tar.gz",
"has_sig": false,
"md5_digest": "e95d8ac5ee73adf79fae1656ee27579c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 58751,
"upload_time": "2024-01-07T06:24:48",
"upload_time_iso_8601": "2024-01-07T06:24:48.190409Z",
"url": "https://files.pythonhosted.org/packages/7b/7a/3c3bd978690c71ecadee7d0e4b23d49cbb10963323080f1dce68651551f7/carefree-toolkit-0.3.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-07 06:24:48",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "carefree0910",
"github_project": "carefree-toolkit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "carefree-toolkit"
}
JSON
