units

New in version 0.9.0.

Contents

class ooodev.units.UnitCM(value)

Unit in cm units.

Supports UnitT protocol.

See also

UnitT

New in version 0.9.4.

Parameters:

value (float) –

classmethod from_cm(value)

Get instance from cm value.

Parameters:

value (float) – cm value.

Return type:

UnitCM

classmethod from_inch(value)

Get instance from in (inch) value.

Parameters:

value (int) – in value.

Return type:

UnitCM

classmethod from_inch10(value)

Get instance from 1/10th in (inch) value.

Parameters:

value (int) – `/10th in value.

Return type:

UnitCM

classmethod from_inch100(value)

Get instance from 1/100th in (inch) value.

Parameters:

value (int) – 1/100th in value.

Return type:

UnitCM

classmethod from_inch1000(value)

Get instance from 1/1,000th in (inch) value.

Parameters:

value (int) – 1/1,000th in value.

Return type:

UnitCM

classmethod from_mm(value)

Get instance from mm value.

Parameters:

value (int) – mm value.

Return type:

UnitCM

classmethod from_mm10(value)

Get instance from 1/10th mm value.

Parameters:

value (int) – 1/10th mm value.

Return type:

UnitCM

classmethod from_mm100(value)

Get instance from 1/100th mm value.

Parameters:

value (int) – 1/100th mm value.

Return type:

UnitCM

classmethod from_pt(value)

Get instance from pt (points) value.

Parameters:

value (float) – pt value.

Return type:

UnitCM

classmethod from_px(value)

Get instance from px (pixel) value.

Parameters:

value (float) – px value.

Return type:

UnitCM

get_value_cm()

Gets instance value converted to cm units.

Returns:

Value in cm units.

Return type:

int

get_value_mm()

Gets instance value converted to mm units.

Returns:

Value in mm units.

Return type:

int

get_value_mm100()

Gets instance value converted to 1/100th mm units.

Returns:

Value in 1/100th mm units.

Return type:

int

get_value_pt()

Gets instance value converted to pt (points) units.

Returns:

Value in pt units.

Return type:

int

get_value_px()

Gets instance value in px (pixel) units.

Returns:

Value in px units.

Return type:

int

value: float

Float value.

class ooodev.units.UnitConvert

static asserting_gcd(m, n)

Find the greatest common divisor of the two integers

Parameters:

• m (int) – The first integer to find the GCD for

• n (int) – The second integer to find the GCD for

Raises:

AssertionError – If GCD result equals 0.

Returns:

A value, representing the greatest common divisor (GCD) for two integers

Return type:

int

classmethod convert(num: int | float, frm: ooodev.units.unit_convert.UnitLength, to: ooodev.units.unit_convert.UnitLength) → float

classmethod convert(num: int | float, frm: int, to: int) → float

classmethod convert(num, frm, to)

Converts a number from one unit to another unit.

Parameters:

• num (N) – Number to convert such as a float or int.

• frm (int | Length) – Current number kind.

• to (int | Length) – Kind to convert to.

Returns:

Converted number

Return type:

float

Note

If Length is not used then mul_div() is called directly.

classmethod convert_mm100_mm(num)

Converts mm to 1/100th mm

Parameters:

num (N) – Number to convert

Returns:

Converted number

Return type:

float

classmethod convert_mm100_pt(num)

Converts 1/100th mm to points

Parameters:

num (N) – Number to convert

Returns:

Converted number

Return type:

float

classmethod convert_mm_mm100(num)

Converts 1/100th mm to mm

Parameters:

num (N) – Number to convert

Returns:

Converted number

Return type:

float

classmethod convert_pt_mm100(num)

Converts points to 1/100th mm

Parameters:

num (N) – Number to convert

Returns:

Converted number

Return type:

float

classmethod convert_twip_mm100(num)

Converts twips to 1/100th mm

Parameters:

num (N) – Number to convert

Returns:

Converted number

Return type:

float

static make_unsigned(num)

Gets unsigned number

Parameters:

num (N) – Number

Raises:

AssertionError – If num is a negative number.

Returns:

Value of num if positive number.

Return type:

N

static mul_div(num, mul, div)

Multiplies and divides.

Parameters:

• num (N) – number

• mul (N) – multiplier

• div (N) – divisor

Returns:

Converted Number

Return type:

float

Note

Formula num * (mul / div)

classmethod to_twips(num, frm)

Converts number to twips

Parameters:

• num (N) – Number to convert

• frm (Length) – The number kind to convert to twips

Returns:

Converted number

Return type:

float

class ooodev.units.UnitInch(value)

Unit in inch units.

Supports UnitT protocol.

See also

UnitT

Parameters:

value (float) –

classmethod from_cm(value)

Get instance from cm value.

Parameters:

value (float) – cm value.

Return type:

UnitInch

classmethod from_inch10(value)

Get instance from 1/10th in (inch) value.

Parameters:

value (int) – 1/10th in value.

Return type:

UnitInch

classmethod from_inch100(value)

Get instance from 1/100th in (inch) value.

Parameters:

value (int) – 1/100th in value.

Return type:

UnitInch

classmethod from_inch1000(value)

Get instance from 1/1,000th in (inch) value.

Parameters:

value (int) – 1/1,000th in value.

Return type:

UnitInch

classmethod from_mm(value)

Get instance from mm value.

Parameters:

value (float) – mm value.

Return type:

UnitInch

classmethod from_mm100(value)

Get instance from 1/100th mm value.

Parameters:

value (int) – 1/100th mm value.

Return type:

UnitInch

classmethod from_pt(value)

Get instance from pt (points) value.

Parameters:

value (float) – pt value.

Return type:

UnitInch

classmethod from_px(value)

Get instance from px (pixel) value.

Parameters:

value (float) – px value.

Return type:

UnitInch

get_value_cm()

Gets instance value converted to cm units.

Returns:

Value in cm units.

Return type:

int

get_value_mm()

Gets instance value converted to Size in mm units.

Returns:

Value in mm units.

Return type:

int

get_value_mm100()

Gets instance value converted to Size in 1/100th mm units.

Returns:

Value in 1/100th mm units.

Return type:

int

get_value_pt()

Gets instance value converted to Size in pt (points) units.

Returns:

Value in pt units.

Return type:

int

get_value_px()

Gets instance value in px (pixel) units.

Returns:

Value in px units.

Return type:

int

value: float

Float value.

class ooodev.units.UnitInch10(value)

Unit in 1/10th in units.

Supports UnitT protocol.

See also

UnitT

Parameters:

value (float) –

classmethod from_cm(value)

Get instance from cm value.

Parameters:

value (float) – cm value.

Return type:

UnitInch10

classmethod from_in(value)

Get instance from in (inch) value.

Parameters:

value (float) – in value.

Return type:

UnitInch10

classmethod from_inch10(value)

Get instance from 1/10th in (inch) value.

Parameters:

value (int) – 1/10th in value.

Return type:

UnitInch10

classmethod from_inch100(value)

Get instance from 1/100th in (inch) value.

Parameters:

value (int) – 1/100th in value.

Return type:

UnitInch10

classmethod from_inch1000(value)

Get instance from 1/1,000th in (inch) value.

Parameters:

value (int) – 1/1,000th in value.

Return type:

UnitInch10

classmethod from_mm100(value)

Get instance from 1/100th mm value.

Parameters:

value (int) – 1/100th mm value.

Return type:

UnitInch10

classmethod from_pt(value)

Get instance from pt (points) value.

Parameters:

value (float) – pt value.

Return type:

UnitInch10

classmethod from_px(value)

Get instance from px (pixel) value.

Parameters:

value (float) – px value.

Return type:

UnitInch10

get_value_cm()

Gets instance value converted to cm units.

Returns:

Value in cm units.

Return type:

int

get_value_mm()

Gets instance value converted to mm units.

Returns:

Value in mm units.

Return type:

int

get_value_mm100()

Gets instance value converted to 1/100th mm units.

Returns:

Value in 1/100th mm units.

Return type:

int

get_value_pt()

Gets instance value converted to Size in pt (points) units.

Returns:

Value in pt units.

Return type:

int

get_value_px()

Gets instance value in px (pixel) units.

Returns:

Value in px units.

Return type:

int

value: float

Float value.

class ooodev.units.UnitInch100(value)

Unit in 1/100th in units.

Supports UnitT protocol.

See also

UnitT

Parameters:

value (float) –

classmethod from_cm(value)

Get instance from cm value.

Parameters:

value (float) – cm value.

Return type:

UnitInch100

classmethod from_in(value)

Get instance from in (inch) value.

Parameters:

value (float) – in value.

Return type:

UnitInch100

classmethod from_inch10(value)

Get instance from 1/10th in (inch) value.

Parameters:

value (int) – 1/10th in value.

Return type:

UnitInch100

classmethod from_inch100(value)

Get instance from 1/10th in (inch) value.

Parameters:

value (int) – 1/10th in value.

Return type:

UnitInch100

classmethod from_inch1000(value)

Get instance from 1/1,000th in (inch) value.

Parameters:

value (int) – 1/1,000th in value.

Return type:

UnitInch100

classmethod from_mm100(value)

Get instance from 1/100th mm value.

Parameters:

value (int) – 1/100th mm value.

Return type:

UnitInch100

classmethod from_pt(value)

Get instance from pt (points) value.

Parameters:

value (float) – pt value.

Return type:

UnitInch100

classmethod from_px(value)

Get instance from px (pixel) value.

Parameters:

value (float) – px value.

Return type:

UnitInch100

get_value_cm()

Gets instance value converted to cm units.

Returns:

Value in cm units.

Return type:

int

get_value_mm()

Gets instance value converted to Size in mm units.

Returns:

Value in mm units.

Return type:

int

get_value_mm100()

Gets instance value converted to Size in 1/100th mm units.

Returns:

Value in 1/100th mm units.

Return type:

int

get_value_pt()

Gets instance value converted to Size in pt (points) units.

Returns:

Value in pt units.

Return type:

int

get_value_px()

Gets instance value in px (pixel) units.

Returns:

Value in px units.

Return type:

int

value: float

Float value.

class ooodev.units.UnitInch1000(value)

Represents 1/1,000th in units.

Supports UnitT protocol.

See also

UnitT

Parameters:

value (int) –

classmethod from_cm(value)

Get instance from cm value.

Parameters:

value (int) – cm value.

Return type:

UnitInch1000

classmethod from_inch(value)

Get instance from in (inch) value.

Parameters:

value (int) – in value.

Return type:

UnitInch1000

classmethod from_inch10(value)

Get instance from 1/10th in (inch) value.

Parameters:

value (int) – `/10th in value.

Return type:

UnitInch1000

classmethod from_inch100(value)

Get instance from 1/100th in (inch) value.

Parameters:

value (int) – 1/100th in value.

Return type:

UnitInch1000

classmethod from_inch1000(value)

Get instance from 1/1,000th in (inch) value.

Parameters:

value (int) – 1/1,000th in value.

Return type:

UnitInch1000

classmethod from_mm(value)

Get instance from mm value.

Parameters:

value (int) – mm value.

Return type:

UnitInch1000

classmethod from_pt(value)

Get instance from pt (points) value.

Parameters:

value (int) – pt value.

Return type:

UnitInch1000

classmethod from_px(value)

Get instance from px (pixel) value.

Parameters:

value (float) – px value.

Return type:

UnitInch1000

get_value_cm()

Gets instance value converted to cm units.

Returns:

Value in cm units.

Return type:

int

get_value_mm()

Gets instance value converted to mm units.

Returns:

Value in mm units.

Return type:

int

get_value_mm100()

Gets instance value in 1/100th mm units.

Returns:

Value in 1/100th mm units.

Return type:

int

get_value_pt()

Gets instance value converted to pt (point) units.

Returns:

Value in pt units.

Return type:

int

get_value_px()

Gets instance value in px (pixel) units.

Returns:

Value in px units.

Return type:

int

value: int

Int value.

class ooodev.units.UnitLength(value)

An enumeration.

CH = 18

210 twip (14 px)

Type:

char unit

CM = 3

centimeter

COUNT = 20

EMU = 6

1/360000 cm, 1/914400 in

Type:

English Metric Unit

FT = 14

foot

IN = 13

inch

IN10 = 12

1/10 in

IN100 = 11

1/100 in

IN1000 = 10

1/1000 in

INVALID = -1

invalid

KM = 5

kilometer

LINE = 19

312 twip

Type:

line unit

M = 4

meter

MASTER = 16

1/576 in

Type:

PPT Master Unit

MI = 15

mile

MM = 2

millimeter

MM10 = 1

1/10 mm

MM100 = 0

1/100th mm

PC = 9

1/6 in

Type:

Pica

PT = 8

1/72 in

Type:

Point

PX = 17

15 twip (96 ppi)

Type:

pixel unit

TWIP = 7

1/20 pt

Type:

Twentieth of a point aka dxa

class ooodev.units.UnitMM(value)

Unit in mm units.

Supports UnitT protocol.

See also

UnitT

Parameters:

value (float) –

classmethod from_cm(value)

Get instance from cm value.

Parameters:

value (int) – cm value.

Return type:

UnitMM

classmethod from_inch(value)

Get instance from in (inch) value.

Parameters:

value (int) – in value.

Return type:

UnitMM

classmethod from_inch10(value)

Get instance from 1/10th in (inch) value.

Parameters:

value (int) – 1/10th in value.

Return type:

UnitMM

classmethod from_inch100(value)

Get instance from 1/100th in (inch) value.

Parameters:

value (int) – 1/100th in value.

Return type:

UnitMM

classmethod from_inch1000(value)

Get instance from 1/1,000th in (inch) value.

Parameters:

value (int) – 1/1,000th in value.

Return type:

UnitMM

classmethod from_mm(value)

Get instance from mm value.

Parameters:

value (int) – mm value.

Return type:

UnitMM

classmethod from_mm10(value)

Get instance from 1/10th mm value.

Parameters:

value (int) – 1/10th mm value.

Return type:

UnitMM

classmethod from_mm100(value)

Get instance from 1/100th mm value.

Parameters:

value (int) – 1/100th mm value.

Return type:

UnitMM

classmethod from_pt(value)

Get instance from pt (points) value.

Parameters:

value (float) – pt value.

Return type:

UnitMM

classmethod from_px(value)

Get instance from px (pixel) value.

Parameters:

value (float) – px value.

Return type:

UnitMM

get_value_cm()

Gets instance value converted to cm units.

Returns:

Value in cm units.

Return type:

int

get_value_mm()

Gets instance value converted to Size in mm units.

Returns:

Value in mm units.

Return type:

int

get_value_mm100()

Gets instance value converted to Size in 1/100th mm units.

Returns:

Value in 1/100th mm units.

Return type:

int

get_value_pt()

Gets instance value converted to Size in pt (points) units.

Returns:

Value in pt units.

Return type:

int

get_value_px()

Gets instance value in px (pixel) units.

Returns:

Value in px units.

Return type:

int

value: float

Float value.

class ooodev.units.UnitMM10(value)

Unit in 1/10th mm units.

Supports UnitT protocol.

See also

UnitT

Parameters:

value (float) –

classmethod from_cm(value)

Get instance from cm value.

Parameters:

value (int) – cm value.

Return type:

UnitMM10

classmethod from_inch(value)

Get instance from in (inch) value.

Parameters:

value (int) – in value.

Return type:

UnitMM10

classmethod from_inch10(value)

Get instance from 1/10th in (inch) value.

Parameters:

value (int) – `/10th in value.

Return type:

UnitMM10

classmethod from_inch100(value)

Get instance from 1/100th in (inch) value.

Parameters:

value (int) – 1/100th in value.

Return type:

UnitMM10

classmethod from_inch1000(value)

Get instance from 1/1,000th in (inch) value.

Parameters:

value (int) – 1/1,000th in value.

Return type:

UnitMM10

classmethod from_mm(value)

Get instance from mm value.

Parameters:

value (int) – mm value.

Return type:

UnitMM10

classmethod from_mm10(value)

Get instance from 1/10th mm value.

Parameters:

value (int) – 1/10th mm value.

Return type:

UnitMM10

classmethod from_mm100(value)

Get instance from 1/100th mm value.

Parameters:

value (int) – 1/100th mm value.

Return type:

UnitMM10

classmethod from_pt(value)

Get instance from pt (points) value.

Parameters:

value (float) – pt value.

Return type:

UnitMM10

classmethod from_px(value)

Get instance from px (pixel) value.

Parameters:

value (float) – px value.

Return type:

UnitMM10

get_value_cm()

Gets instance value converted to cm units.

Returns:

Value in cm units.

Return type:

int

get_value_mm()

Gets instance value converted to mm units.

Returns:

Value in mm units.

Return type:

int

get_value_mm100()

Gets instance value converted to 1/100th mm units.

Returns:

Value in 1/100th mm units.

Return type:

int

get_value_pt()

Gets instance value converted to pt (points) units.

Returns:

Value in pt units.

Return type:

int

get_value_px()

Gets instance value in px (pixel) units.

Returns:

Value in px units.

Return type:

int

value: float

Float value.

class ooodev.units.UnitMM100(value)

Represents 1/100th mm units.

Supports UnitT protocol.

See also

UnitT

Parameters:

value (int) –

classmethod from_cm(value)

Get instance from cm value.

Parameters:

value (int) – cm value.

Return type:

UnitMM100

classmethod from_inch(value)

Get instance from in (inch) value.

Parameters:

value (int) – in value.

Return type:

UnitMM100

classmethod from_inch10(value)

Get instance from 1/10th in (inch) value.

Parameters:

value (int) – `/10th in value.

Return type:

UnitMM100

classmethod from_inch100(value)

Get instance from 1/100th in (inch) value.

Parameters:

value (int) – 1/100th in value.

Return type:

UnitMM100

classmethod from_inch1000(value)

Get instance from 1/1,000th in (inch) value.

Parameters:

value (int) – 1/1,000th in value.

Return type:

UnitMM100

classmethod from_mm(value)

Get instance from mm value.

Parameters:

value (int) – mm value.

Return type:

UnitMM100

classmethod from_mm10(value)

Get instance from 1/10th mm value.

Parameters:

value (int) – 1/10th mm value.

Return type:

UnitMM100

classmethod from_mm100(value)

Get instance from 1/100th mm value.

Parameters:

value (int) – 1/100th mm value.

Return type:

UnitMM100

classmethod from_pt(value)

Get instance from pt (points) value.

Parameters:

value (int) – pt value.

Return type:

UnitMM100

classmethod from_px(value)

Get instance from px (pixel) value.

Parameters:

value (float) – px value.

Return type:

UnitMM100

get_value_cm()

Gets instance value converted to cm units.

Returns:

Value in cm units.

Return type:

int

get_value_mm()

Gets instance value converted to mm units.

Returns:

Value in mm units.

Return type:

int

get_value_mm100()

Gets instance value in 1/100th mm units.

Returns:

Value in 1/100th mm units.

Return type:

int

get_value_pt()

Gets instance value converted to pt (point) units.

Returns:

Value in pt units.

Return type:

int

get_value_px()

Gets instance value in px (pixel) units.

Returns:

Value in px units.

Return type:

int

value: int

Int value.

class ooodev.units.UnitPT(value)

Represents a PT (points) value.

Supports UnitT protocol.

See also

UnitT

Parameters:

value (float) –

classmethod from_cm(value)

Get instance from cm value.

Parameters:

value (int) – cm value.

Return type:

UnitPT

classmethod from_inch(value)

Get instance from in (inch) value.

Parameters:

value (int) – in value.

Return type:

UnitPT

classmethod from_inch10(value)

Get instance from 1/10th in (inch) value.

Parameters:

value (int) – 1/10th in value.

Return type:

UnitPT

classmethod from_inch100(value)

Get instance from 1/100th in (inch) value.

Parameters:

value (int) – 1/100th in value.

Return type:

UnitPT

classmethod from_inch1000(value)

Get instance from 1/1,000th in (inch) value.

Parameters:

value (int) – 1/1,000th in value.

Return type:

UnitPT

classmethod from_mm(value)

Get instance from mm value.

Parameters:

value (int) – mm value.

Return type:

UnitPT

classmethod from_mm10(value)

Get instance from 1/10th mm value.

Parameters:

value (int) – 1/10th mm value.

Return type:

UnitPT

classmethod from_mm100(value)

Get instance from 1/100th mm value.

Parameters:

value (int) – 1/100th mm value.

Return type:

UnitPT

classmethod from_pt(value)

Get instance from pt (points) value.

Parameters:

value (float) – pt value.

Return type:

UnitPT

classmethod from_px(value)

Get instance from px (pixel) value.

Parameters:

value (float) – px value.

Return type:

UnitPT

get_value_cm()

Gets instance value converted to cm units.

Returns:

Value in cm units.

Return type:

int

get_value_mm()

Gets instance value converted to mm units.

Returns:

Value in mm units.

Return type:

int

get_value_mm100()

Gets instance value converted to 1/100th mm units.

Returns:

Value in 1/100th mm units.

Return type:

int

get_value_pt()

Gets instance value in pt (point) units.

Returns:

Value in pt units.

Return type:

int

get_value_px()

Gets instance value in px (pixel) units.

Returns:

Value in px units.

Return type:

int

value: float

Float value.

class ooodev.units.UnitPX(value)

Represents a PX (pixel) value.

Supports UnitT protocol.

See also

UnitT

Parameters:

value (float) –

classmethod from_cm(value)

Get instance from cm value.

Parameters:

value (int) – cm value.

Return type:

UnitPX

classmethod from_inch(value)

Get instance from in (inch) value.

Parameters:

value (int) – in value.

Return type:

UnitPX

classmethod from_inch10(value)

Get instance from 1/10th in (inch) value.

Parameters:

value (int) – 1/10th in value.

Return type:

UnitPX

classmethod from_inch100(value)

Get instance from 1/100th in (inch) value.

Parameters:

value (int) – 1/100th in value.

Return type:

UnitPX

classmethod from_inch1000(value)

Get instance from 1/1,000th in (inch) value.

Parameters:

value (int) – 1/1,000th in value.

Return type:

UnitPX

classmethod from_mm(value)

Get instance from mm value.

Parameters:

value (int) – mm value.

Return type:

UnitPX

classmethod from_mm10(value)

Get instance from 1/10th mm value.

Parameters:

value (int) – 1/10th mm value.

Return type:

UnitPX

classmethod from_mm100(value)

Get instance from 1/100th mm value.

Parameters:

value (int) – 1/100th mm value.

Return type:

UnitPX

classmethod from_pt(value)

Get instance from pt (points) value.

Parameters:

value (float) – pt value.

Return type:

UnitPX

classmethod from_px(value)

Get instance from px (pixel) value.

Parameters:

value (float) – px value.

Return type:

UnitPX

get_value_cm()

Gets instance value converted to cm units.

Returns:

Value in cm units.

Return type:

int

get_value_mm()

Gets instance value converted to mm units.

Returns:

Value in mm units.

Return type:

int

get_value_mm100()

Gets instance value converted to 1/100th mm units.

Returns:

Value in 1/100th mm units.

Return type:

int

get_value_pt()

Gets instance value in pt (point) units.

Returns:

Value in pt units.

Return type:

int

get_value_px()

Gets instance value in px (pixel) units.

Returns:

Value in px units.

Return type:

int

value: float

Float value.

class ooodev.units.UnitT

Protocol Class for units.

See also

units

UnitT

get_value_mm()

Gets instance value converted to Size in mm units.

Returns:

Value in mm units.

Return type:

float

get_value_mm100()

Gets instance value converted to Size in 1/100th mm units.

Returns:

Value in 1/100th mm units.

Return type:

int

get_value_pt()

Gets instance value converted to Size in pt (point) units.

Returns:

Value in pt units.

Return type:

float

get_value_px()

Gets instance value in px (pixel) units.

Returns:

Value in px units.

Return type:

float

property value: float | int

Unit actual value. Generally a float or int

Return type:

float | int