Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added bits conversion to the ByteSize class feature #8415 #8507

Merged
merged 4 commits into from Jan 8, 2024
Merged

Added bits conversion to the ByteSize class feature #8415 #8507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d14635e
Added bit units
luca-matei Jan 6, 2024
2202dd0
Added bit units
luca-matei Jan 7, 2024
3feb7c5
Added test cases for ByteSize bit conversion
luca-matei Jan 7, 2024
23fd3f3
Added docs for bit conversion
luca-matei Jan 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 18 additions & 3 deletions pydantic/types.py
View file
Open in desktop
Expand Up @@ -1724,6 +1724,19 @@ def validate_brand(card_number: str) -> PaymentCardBrand:
'tib': 2**40,
'pib': 2**50,
'eib': 2**60,
'bit': 1 / 8,
'kbit': 10**3 / 8,
'mbit': 10**6 / 8,
'gbit': 10**9 / 8,
'tbit': 10**12 / 8,
'pbit': 10**15 / 8,
'ebit': 10**18 / 8,
'kibit': 2**10 / 8,
'mibit': 2**20 / 8,
'gibit': 2**30 / 8,
'tibit': 2**40 / 8,
'pibit': 2**50 / 8,
'eibit': 2**60 / 8,
}
BYTE_SIZES.update({k.lower()[0]: v for k, v in BYTE_SIZES.items() if 'i' not in k})
byte_string_re = re.compile(r'^\s*(\d*\.?\d+)\s*(\w+)?', re.IGNORECASE)
Expand Down Expand Up @@ -1821,11 +1834,13 @@ def human_readable(self, decimal: bool = False) -> str:
return f'{num:0.1f}{final_unit}'

def to(self, unit: str) -> float:
"""Converts a byte size to another unit.
"""Converts a byte size to another unit, including both byte and bit units.

Args:
unit: The unit to convert to. Must be one of the following: B, KB, MB, GB, TB, PB, EiB,
KiB, MiB, GiB, TiB, PiB, EiB.
unit: The unit to convert to. Must be one of the following: B, KB, MB, GB, TB, PB, EB,
KiB, MiB, GiB, TiB, PiB, EiB (byte units) and
bit, kbit, mbit, gbit, tbit, pbit, ebit,
kibit, mibit, gibit, tibit, pibit, eibit (bit units).

Returns:
The byte size in the new unit.
Expand Down
13 changes: 13 additions & 0 deletions pydantic/v1/types.py
View file
Open in desktop
Expand Up @@ -1082,6 +1082,19 @@ def _get_brand(card_number: str) -> PaymentCardBrand:
'tib': 2**40,
'pib': 2**50,
'eib': 2**60,
'bit': 1/8,
'kbit': 10**3/8,
'mbit': 10**6/8,
'gbit': 10**9/8,
'tbit': 10**12/8,
'pbit': 10**15/8,
'ebit': 10**18/8,
'kibit': 2**10/8,
'mibit': 2**20/8,
'gibit': 2**30/8,
'tibit': 2**40/8,
'pibit': 2**50/8,
'eibit': 2**60/8,
}
BYTE_SIZES.update({k.lower()[0]: v for k, v in BYTE_SIZES.items() if 'i' not in k})
byte_string_re = re.compile(r'^\s*(\d*\.?\d+)\s*(\w+)?', re.IGNORECASE)
Expand Down
7 changes: 7 additions & 0 deletions tests/test_types.py
View file
Open in desktop
Expand Up @@ -4444,6 +4444,8 @@ class FrozenSetModel(BaseModel):
('1.5 M', int(1.5e6), '1.4MiB', '1.5MB'),
('5.1kib', 5222, '5.1KiB', '5.2KB'),
('6.2EiB', 7148113328562451456, '6.2EiB', '7.1EB'),
('8bit', 1, '1B', '1B'),
('1kbit', 125, '125B', '125B'),
),
)
def test_bytesize_conversions(input_value, output, human_bin, human_dec):
Expand All @@ -4467,6 +4469,8 @@ class Model(BaseModel):
assert m.size.to('MiB') == pytest.approx(1024)
assert m.size.to('MB') == pytest.approx(1073.741824)
assert m.size.to('TiB') == pytest.approx(0.0009765625)
assert m.size.to('bit') == pytest.approx(8589934592)
assert m.size.to('kbit') == pytest.approx(8589934.592)


def test_bytesize_raises():
Expand All @@ -4487,6 +4491,9 @@ class Model(BaseModel):
with pytest.raises(PydanticCustomError, match='byte unit'):
m.size.to('bad_unit')

with pytest.raises(PydanticCustomError, match='byte unit'):
m.size.to('1ZiB')


def test_deque_success():
class Model(BaseModel):
Expand Down