1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: module phonenumbers.phonemetadata</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
</head><body bgcolor="#f0f0f8">
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
<tr bgcolor="#7799ee">
<td valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="phonenumbers.html"><font color="#ffffff">phonenumbers</font></a>.phonemetadata</strong></big></big></font></td
><td align=right valign=bottom
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="https://github.com/daviddrysdale/python-phonenumbers/blob/dev/python/phonenumbers/phonemetadata.py">phonenumbers/phonemetadata.py</a></font></td></tr></table>
<p><tt><a href="#PhoneMetadata">PhoneMetadata</a> object definitions</tt></p>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#aa55cc">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="threading.html">threading</a><br>
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ee77aa">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
<td width="100%"><dl>
<dt><font face="helvetica, arial"><a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>(<a href="builtins.html#object">builtins.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="phonenumbers.phonemetadata.html#NumberFormat">NumberFormat</a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)
</font></dt><dt><font face="helvetica, arial"><a href="phonenumbers.phonemetadata.html#PhoneMetadata">PhoneMetadata</a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)
</font></dt><dt><font face="helvetica, arial"><a href="phonenumbers.phonemetadata.html#PhoneNumberDesc">PhoneNumberDesc</a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)
</font></dt></dl>
</dd>
<dt><font face="helvetica, arial"><a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>(<a href="builtins.html#object">builtins.object</a>)
</font></dt><dd>
<dl>
<dt><font face="helvetica, arial"><a href="phonenumbers.phonemetadata.html#NumberFormat">NumberFormat</a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)
</font></dt><dt><font face="helvetica, arial"><a href="phonenumbers.phonemetadata.html#PhoneMetadata">PhoneMetadata</a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)
</font></dt><dt><font face="helvetica, arial"><a href="phonenumbers.phonemetadata.html#PhoneNumberDesc">PhoneNumberDesc</a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)
</font></dt></dl>
</dd>
</dl>
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="NumberFormat">class <strong>NumberFormat</strong></a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt><a href="#NumberFormat">NumberFormat</a>(*__args, **__kwargs)<br>
<br>
Representation of way that a phone number can be formatted for output<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="phonenumbers.phonemetadata.html#NumberFormat">NumberFormat</a></dd>
<dd><a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a></dd>
<dd><a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="NumberFormat-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Return self==value.</tt></dd></dl>
<dl><dt><a name="NumberFormat-__init__"><strong>__init__</strong></a> = wrapper(self, *__args, **__kwargs)</dt></dl>
<dl><dt><a name="NumberFormat-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Return self!=value.</tt></dd></dl>
<dl><dt><a name="NumberFormat-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return repr(self).</tt></dd></dl>
<dl><dt><a name="NumberFormat-__unicode__"><strong>__unicode__</strong></a>(self)</dt></dl>
<dl><dt><a name="NumberFormat-merge_from"><strong>merge_from</strong></a>(self, other)</dt><dd><tt>Merge information from another <a href="#NumberFormat">NumberFormat</a> object into this one.</tt></dd></dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__hash__</strong> = None</dl>
<hr>
Methods inherited from <a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>:<br>
<dl><dt><a name="NumberFormat-__str__"><strong>__str__</strong></a>(self)</dt><dd><tt>Return str(self).</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>:<br>
<dl><dt><a name="NumberFormat-__delattr__"><strong>__delattr__</strong></a>(self, name)</dt><dd><tt>Implement delattr(self, name).</tt></dd></dl>
<dl><dt><a name="NumberFormat-__setattr__"><strong>__setattr__</strong></a>(self, name, value)</dt><dd><tt>Implement setattr(self, name, value).</tt></dd></dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="PhoneMetadata">class <strong>PhoneMetadata</strong></a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt><a href="#PhoneMetadata">PhoneMetadata</a>(*__args, **__kwargs)<br>
<br>
Class representing metadata for international telephone numbers for a region.<br>
<br>
This class is hand created based on phonemetadata.proto. Please refer to that file<br>
for detailed descriptions of the meaning of each field.<br>
<br>
WARNING: This API isn't stable. It is considered libphonenumber-internal<br>
and can change at any time. We only declare it as public for easy<br>
inclusion in our build tools not in this package. Clients should not<br>
refer to this file, we do not commit to support backwards-compatibility or<br>
to warn about breaking changes.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="phonenumbers.phonemetadata.html#PhoneMetadata">PhoneMetadata</a></dd>
<dd><a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a></dd>
<dd><a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="PhoneMetadata-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Return self==value.</tt></dd></dl>
<dl><dt><a name="PhoneMetadata-__init__"><strong>__init__</strong></a> = wrapper(self, *__args, **__kwargs)</dt></dl>
<dl><dt><a name="PhoneMetadata-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Return self!=value.</tt></dd></dl>
<dl><dt><a name="PhoneMetadata-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return repr(self).</tt></dd></dl>
<dl><dt><a name="PhoneMetadata-__unicode__"><strong>__unicode__</strong></a>(self)</dt></dl>
<hr>
Class methods defined here:<br>
<dl><dt><a name="PhoneMetadata-load_all"><strong>load_all</strong></a>()<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt><dd><tt>Force immediate load of all metadata</tt></dd></dl>
<dl><dt><a name="PhoneMetadata-metadata_for_nongeo_region"><strong>metadata_for_nongeo_region</strong></a>(country_code, default=None)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
<dl><dt><a name="PhoneMetadata-metadata_for_region"><strong>metadata_for_region</strong></a>(region_code, default=None)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
<dl><dt><a name="PhoneMetadata-metadata_for_region_or_calling_code"><strong>metadata_for_region_or_calling_code</strong></a>(country_calling_code, region_code)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
<dl><dt><a name="PhoneMetadata-register_nongeo_region_loader"><strong>register_nongeo_region_loader</strong></a>(country_code, loader)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
<dl><dt><a name="PhoneMetadata-register_region_loader"><strong>register_region_loader</strong></a>(region_code, loader)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
<dl><dt><a name="PhoneMetadata-register_short_region_loader"><strong>register_short_region_loader</strong></a>(region_code, loader)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
<dl><dt><a name="PhoneMetadata-short_metadata_for_region"><strong>short_metadata_for_region</strong></a>(region_code, default=None)<font color="#909090"><font face="helvetica, arial"> from <a href="builtins.html#type">builtins.type</a></font></font></dt></dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__hash__</strong> = None</dl>
<hr>
Methods inherited from <a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>:<br>
<dl><dt><a name="PhoneMetadata-__str__"><strong>__str__</strong></a>(self)</dt><dd><tt>Return str(self).</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>:<br>
<dl><dt><a name="PhoneMetadata-__delattr__"><strong>__delattr__</strong></a>(self, name)</dt><dd><tt>Implement delattr(self, name).</tt></dd></dl>
<dl><dt><a name="PhoneMetadata-__setattr__"><strong>__setattr__</strong></a>(self, name, value)</dt><dd><tt>Implement setattr(self, name, value).</tt></dd></dl>
</td></tr></table> <p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><a name="PhoneNumberDesc">class <strong>PhoneNumberDesc</strong></a>(<a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>, <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt><a href="#PhoneNumberDesc">PhoneNumberDesc</a>(*__args, **__kwargs)<br>
<br>
Class representing the description of a set of phone numbers.<br> </tt></td></tr>
<tr><td> </td>
<td width="100%"><dl><dt>Method resolution order:</dt>
<dd><a href="phonenumbers.phonemetadata.html#PhoneNumberDesc">PhoneNumberDesc</a></dd>
<dd><a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a></dd>
<dd><a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a></dd>
<dd><a href="builtins.html#object">builtins.object</a></dd>
</dl>
<hr>
Methods defined here:<br>
<dl><dt><a name="PhoneNumberDesc-__eq__"><strong>__eq__</strong></a>(self, other)</dt><dd><tt>Return self==value.</tt></dd></dl>
<dl><dt><a name="PhoneNumberDesc-__init__"><strong>__init__</strong></a> = wrapper(self, *__args, **__kwargs)</dt></dl>
<dl><dt><a name="PhoneNumberDesc-__ne__"><strong>__ne__</strong></a>(self, other)</dt><dd><tt>Return self!=value.</tt></dd></dl>
<dl><dt><a name="PhoneNumberDesc-__repr__"><strong>__repr__</strong></a>(self)</dt><dd><tt>Return repr(self).</tt></dd></dl>
<dl><dt><a name="PhoneNumberDesc-__unicode__"><strong>__unicode__</strong></a>(self)</dt></dl>
<dl><dt><a name="PhoneNumberDesc-merge_from"><strong>merge_from</strong></a>(self, other)</dt><dd><tt>Merge information from another <a href="#PhoneNumberDesc">PhoneNumberDesc</a> object into this one.</tt></dd></dl>
<hr>
Data and other attributes defined here:<br>
<dl><dt><strong>__hash__</strong> = None</dl>
<hr>
Methods inherited from <a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>:<br>
<dl><dt><a name="PhoneNumberDesc-__str__"><strong>__str__</strong></a>(self)</dt><dd><tt>Return str(self).</tt></dd></dl>
<hr>
Data descriptors inherited from <a href="phonenumbers.util.html#UnicodeMixin">phonenumbers.util.UnicodeMixin</a>:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
<hr>
Methods inherited from <a href="phonenumbers.util.html#ImmutableMixin">phonenumbers.util.ImmutableMixin</a>:<br>
<dl><dt><a name="PhoneNumberDesc-__delattr__"><strong>__delattr__</strong></a>(self, name)</dt><dd><tt>Implement delattr(self, name).</tt></dd></dl>
<dl><dt><a name="PhoneNumberDesc-__setattr__"><strong>__setattr__</strong></a>(self, name, value)</dt><dd><tt>Implement setattr(self, name, value).</tt></dd></dl>
</td></tr></table></td></tr></table><p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#55aa55">
<td colspan=3 valign=bottom> <br>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
<td width="100%"><strong>REGION_CODE_FOR_NON_GEO_ENTITY</strong> = '001'</td></tr></table>
</body></html>
|