babel.support.Format Class Reference

Public Member Functions
None	__init__ (self, Locale|str locale, _datetime.tzinfo|None tzinfo=None, *Literal["default"]|str numbering_system="latn")
str	date (self, _datetime.date|None date=None, _PredefinedTimeFormat|str format='medium')
str	datetime (self, _datetime.date|None datetime=None, _PredefinedTimeFormat|str format='medium')
str	time (self, _datetime.time|_datetime.datetime|None time=None, _PredefinedTimeFormat|str format='medium')
str	timedelta (self, _datetime.timedelta|int delta, Literal["year", "month", "week", "day", "hour", "minute", "second"] granularity="second", float threshold=0.85, Literal["narrow", "short", "medium", "long"] format="long", bool add_direction=False)
str	number (self, float|Decimal|str number)
str	decimal (self, float|Decimal|str number, str|None format=None)
str	compact_decimal (self, float|Decimal|str number, Literal['short', 'long'] format_type='short', int fraction_digits=0)
str	currency (self, float|Decimal|str number, str currency)
str	compact_currency (self, float|Decimal|str number, str currency, Literal['short'] format_type='short', int fraction_digits=0)
str	percent (self, float|Decimal|str number, str|None format=None)
str	scientific (self, float|Decimal|str number)

Public Attributes
	locale
	tzinfo
	numbering_system

Detailed Description

Wrapper class providing the various date and number formatting functions
bound to a specific locale and time-zone.

>>> from babel.util import UTC
>>> from datetime import date
>>> fmt = Format('en_US', UTC)
>>> fmt.date(date(2007, 4, 1))
u'Apr 1, 2007'
>>> fmt.decimal(1.2345)
u'1.234'

Constructor & Destructor Documentation

__init__()

None babel.support.Format.__init__	(		self,
		Locale | str	locale,
		_datetime.tzinfo | None	tzinfo = None,
		*Literal["default"] | str	numbering_system = "latn"
	)

Initialize the formatter.

:param locale: the locale identifier or `Locale` instance
:param tzinfo: the time-zone info (a `tzinfo` instance or `None`)
:param numbering_system: The numbering system used for formatting number symbols. Defaults to "latn".
                         The special value "default" will use the default numbering system of the locale.

Member Function Documentation

compact_currency()

str babel.support.Format.compact_currency	(		self,
		float | Decimal | str	number,
		str	currency,
		Literal['short']	format_type = 'short',
		int	fraction_digits = 0
	)

Return a number in the given currency formatted for the locale
using the compact number format.

>>> Format('en_US').compact_currency(1234567, "USD", format_type='short', fraction_digits=2)
'$1.23M'

compact_decimal()

str babel.support.Format.compact_decimal	(		self,
		float | Decimal | str	number,
		Literal['short', 'long']	format_type = 'short',
		int	fraction_digits = 0
	)

Return a number formatted in compact form for the locale.

>>> fmt = Format('en_US')
>>> fmt.compact_decimal(123456789)
u'123M'
>>> fmt.compact_decimal(1234567, format_type='long', fraction_digits=2)
'1.23 million'

currency()

str babel.support.Format.currency	(		self,
		float | Decimal | str	number,
		str	currency
	)

Return a number in the given currency formatted for the locale.

date()

str babel.support.Format.date	(		self,
		_datetime.date | None	date = None,
		_PredefinedTimeFormat | str	format = 'medium'
	)

Return a date formatted according to the given pattern.

>>> from datetime import date
>>> fmt = Format('en_US')
>>> fmt.date(date(2007, 4, 1))
u'Apr 1, 2007'

datetime()

str babel.support.Format.datetime	(		self,
		_datetime.date | None	datetime = None,
		_PredefinedTimeFormat | str	format = 'medium'
	)

Return a date and time formatted according to the given pattern.

>>> from datetime import datetime
>>> from babel.dates import get_timezone
>>> fmt = Format('en_US', tzinfo=get_timezone('US/Eastern'))
>>> fmt.datetime(datetime(2007, 4, 1, 15, 30))
u'Apr 1, 2007, 11:30:00\u202fAM'

decimal()

str babel.support.Format.decimal	(		self,
		float | Decimal | str	number,
		str | None	format = None
	)

Return a decimal number formatted for the locale.

>>> fmt = Format('en_US')
>>> fmt.decimal(1.2345)
u'1.234'

number()

str babel.support.Format.number	(		self,
		float | Decimal | str	number
	)

Return an integer number formatted for the locale.

>>> fmt = Format('en_US')
>>> fmt.number(1099)
u'1,099'

percent()

str babel.support.Format.percent	(		self,
		float | Decimal | str	number,
		str | None	format = None
	)

Return a number formatted as percentage for the locale.

>>> fmt = Format('en_US')
>>> fmt.percent(0.34)
u'34%'

scientific()

str babel.support.Format.scientific	(		self,
		float | Decimal | str	number
	)

Return a number formatted using scientific notation for the locale.

time()

str babel.support.Format.time	(		self,
		_datetime.time | _datetime.datetime | None	time = None,
		_PredefinedTimeFormat | str	format = 'medium'
	)

Return a time formatted according to the given pattern.

>>> from datetime import datetime
>>> from babel.dates import get_timezone
>>> fmt = Format('en_US', tzinfo=get_timezone('US/Eastern'))
>>> fmt.time(datetime(2007, 4, 1, 15, 30))
u'11:30:00\u202fAM'

timedelta()

str babel.support.Format.timedelta	(		self,
		_datetime.timedelta | int	delta,
		Literal["year", "month", "week", "day", "hour", "minute", "second"]	granularity = "second",
		float	threshold = 0.85,
		Literal["narrow", "short", "medium", "long"]	format = "long",
		bool	add_direction = False
	)

Return a time delta according to the rules of the given locale.

>>> from datetime import timedelta
>>> fmt = Format('en_US')
>>> fmt.timedelta(timedelta(weeks=11))
u'3 months'

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/babel/support.py