commonutil.convert

值轉換輔助函式值 / Value convert functions

parse_hostport_location(loc, default_value=None)[source]

解析 Host:Port 型式的字串為 (Host, Port,) 型式的 tuple 物件

Parse string in “Host:Port” form into tuple object in (Host, Port,) form.

Parameters:
  • loc (str) – 要轉換的位址字串
  • default_value=None – 當無法轉換時的預設值
Returns:

轉換結果，或是當失敗時為預設值
parse_hostport_location_list(location_list)[source]

解析 Host:Port 型式的字串 list 為 (Host, Port,) 型式的 tuple 物件所構成的 list

Parse list of strings in “Host:Port” form into list of tuple objects in (Host, Port,) form.

Parameters:location_list (list of str) – 要轉換的位址字串串列
Returns:轉換結果，或是當失敗時為空的 tuple 物件
to_bool(v, default_value=None)[source]

將輸入值轉換為布林值，當輸入值為 None 或是無法轉換的物件時傳回 None

Convert given variable into boolean. Return None or given default value when convert failed.

Parameters:
  • v – 要轉換的值或物件
  • default_value=None – 預設值
Returns:

布林值，或是 None 當輸入無法轉換
to_datetime(v, default_value=None)[source]

將輸入值轉換為時間格式，當輸入值為 None 或是無法轉換的物件時傳回 None

Convert given variable into datetime.datetime object. Return None or given default value when convert failed.

輸入範例 / Input Examples:
整數/浮點數 (視為 UNIX time-stamp) / Integer or Float (will treat as UNIT time-stamp):
1352454146.387523
字串 / String:
‘2012-11-10 10:10:10’, ‘+01’ (加 1 小時), ‘+0123’ (加 1 小時 23 分鐘)
串列或數對 / List or Tuple):
(2012, 11, 10, 10, 10, 10, 0, 0, 0,)
Parameters:
  • v – 要轉換的值或物件
  • default_value=None – 預設值
Returns:

時間格式，或是 None 當輸入無法轉換
to_dict(v, element_converter, key_converter=None, default_value=None)[source]

將輸入值轉換為字典，各輸入值透過傳入的轉換函式進行轉換

Convert given variable into dict object with given key and value convert function. Return None or given default value when convert failed or result into empty dict.

Parameters:
  • v – 要轉換的值或物件
  • element_converter (callable) – 單一個元素的轉換函式，當轉換結果為 None 時此元素會被丟棄
  • key_converter=None (callable) – 單一元素對應之鍵值的轉換函式，當轉換結果為 None 時此元素會被丟棄
  • default_value=None – 預設值
Returns:

字典，或是 None 當輸入無法轉換
to_float(v, default_value=None)[source]

將輸入值轉換為浮點數，當輸入值為 None 或是無法轉換的物件時傳回 None

Convert given variable into float. Return None or given default value when convert failed.

Parameters:
  • v – 要轉換的值或物件
  • default_value=None – 預設值
Returns:

非空字串，或是 None 當輸入是空字串或是無法轉換的物件
to_integer(v, default_value=None)[source]

將輸入值轉換為整數，當輸入值為 None 或是無法轉換的物件時傳回 None

Convert given variable into integer. Return None or given default value when convert failed.

Parameters:
  • v – 要轉換的值或物件
  • default_value=None – 預設值
Returns:

整數，或是 None 當輸入是空字串或是無法轉換的物件
to_list(v, element_converter, default_value=None)[source]

將輸入值轉換為串列，各輸入值透過傳入的轉換函式進行轉換

Convert given variable into list object with given element convert function. Return None or given default value when convert failed or result into empty list.

Parameters:
  • v – 要轉換的值或物件
  • element_converter (callable) – 單一個元素的轉換函式，當轉換結果為 None 時此元素會被丟棄
  • default_value=None – 預設值
Returns:

串列，或是 None 當輸入無法轉換
to_text(v, default_value=None)[source]

將輸入值轉換為字串，當輸入值為 None 或空字串或是無法轉換的物件時傳回 None

Convert given variable into string. Return None or given default value when convert failed.

Parameters:
  • v – 要轉換的值或物件
  • default_value=None – 預設值
Returns:

非空字串，或是 None 當輸入是空字串或是無法轉換的物件
to_uuid(v, default_value=None)[source]

將輸入值轉換為 UUID 物件

Convert given variable into UUID object. Return None or given default value when convert failed.

Parameters:
  • v – 要轉換的值或物件
  • default_value=None – 預設值
Returns:

uuid.UUID 物件實體，或是 None 當輸入無法轉換