1. help

uwsgi命令

UWSGI-CORE

1
2
NAME
  - uwsgi-core - fast (pure C), self-healing, developer-friendly WSGI server

User Commands

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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
-s|--socket
       bind to the specified UNIX/TCP socket using default protocol
       指定socket，使用默认协议

-s|--uwsgi-socket
       bind to the specified UNIX/TCP socket using uwsgi protocol
       指定socket，使用uwsgi协议

--suwsgi-socket
       bind to the specified UNIX/TCP socket using uwsgi protocol over SSL
       指定socket，使用uwsgi绑定通过SSL安全套接字层

--ssl-socket
       bind to the specified UNIX/TCP socket using uwsgi protocol over SSL
       指定socket，使用uwsgi协议通过SSL安全套接字层

--http-socket
       bind to the specified UNIX/TCP socket using HTTP protocol
       指定socket，使用HTTP协议

--http-socket-modifier1
       force the specified modifier1 when using HTTP protocol

--http-socket-modifier2
       force the specified modifier2 when using HTTP protocol

--https-socket
       bind to the specified UNIX/TCP socket using HTTPS protocol

--https-socket-modifier1
       force the specified modifier1 when using HTTPS protocol

--https-socket-modifier2
       force the specified modifier2 when using HTTPS protocol

--fastcgi-socket
       bind to the specified UNIX/TCP socket using FastCGI protocol

--fastcgi-nph-socket
       bind to the specified UNIX/TCP socket using FastCGI protocol (nph mode)

--fastcgi-modifier1
       force the specified modifier1 when using FastCGI protocol

--fastcgi-modifier2
       force the specified modifier2 when using FastCGI protocol

--scgi-socket
       bind to the specified UNIX/TCP socket using SCGI protocol

--scgi-nph-socket
       bind to the specified UNIX/TCP socket using SCGI protocol (nph mode)

--scgi-modifier1
       force the specified modifier1 when using SCGI protocol

--scgi-modifier2
       force the specified modifier2 when using SCGI protocol

--raw-socket
       bind to the specified UNIX/TCP socket using RAW protocol

--raw-modifier1
       force the specified modifier1 when using RAW protocol

--raw-modifier2
       force the specified modifier2 when using RAW protocol

--puwsgi-socket
       bind to the specified UNIX/TCP socket using persistent uwsgi protocol (puwsgi)

--protocol
       force the specified protocol for default sockets

--socket-protocol
       force the specified protocol for default sockets

--shared-socket
       create a shared socket for advanced jailing or ipc

--undeferred-shared-socket
       create a shared socket for advanced jailing or ipc (undeferred mode)

-p|--processes
       spawn the specified number of workers/processes

-p|--workers
       spawn the specified number of workers/processes

--thunder-lock
       serialize accept() usage (if possible)

-t|--harakiri
       set harakiri timeout

--harakiri-verbose
       enable verbose mode for harakiri

--harakiri-no-arh
       do not enable harakiri during after-request-hook

--no-harakiri-arh
       do not enable harakiri during after-request-hook

--no-harakiri-after-req-hook
       do not enable harakiri during after-request-hook

--backtrace-depth
       set backtrace depth

--mule-harakiri
       set harakiri timeout for mule tasks

-x|--xmlconfig
       load config from xml file

-x|--xml
       load config from xml file

--config
       load configuration using the pluggable system

--fallback-config
       re-exec uwsgi with the specified config when exit code is 1

--strict
       enable strict mode (placeholder cannot be used)

--skip-zero
       skip check of file descriptor 0

--skip-atexit
       skip atexit hooks (ignored by the master)

--skip-atexit-teardown
       skip atexit teardown (ignored by the master)

-S|--set
       set a placeholder or an option

--set-placeholder
       set a placeholder

--set-ph
       set a placeholder

--get  print the specified option value and exit

--declare-option
       declare a new uWSGI custom option

--declare-option2
       declare a new uWSGI custom option (non-immediate)

--resolve
       place  the  result  of  a dns query in the specified placeholder, sytax: placeholder=name
       (immediate option)

--for  (opt logic) for cycle

--for-glob
       (opt logic) for cycle (expand glob)

--for-times
       (opt logic) for cycle (expand the specified num to a list starting from 1)

--for-readline
       (opt logic) for cycle (expand the specified file to a list of lines)

--endfor
       (opt logic) end for cycle

--end-for
       (opt logic) end for cycle

--if-opt
       (opt logic) check for option

--if-not-opt
       (opt logic) check for option

--if-env
       (opt logic) check for environment variable

--if-not-env
       (opt logic) check for environment variable

--ifenv
       (opt logic) check for environment variable

--if-reload
       (opt logic) check for reload

--if-not-reload
       (opt logic) check for reload

--if-hostname
       (opt logic) check for hostname

--if-not-hostname
       (opt logic) check for hostname

--if-hostname-match
       (opt logic) try to match hostname against a regular expression

--if-not-hostname-match
       (opt logic) try to match hostname against a regular expression

--if-exists
       (opt logic) check for file/directory existence

--if-not-exists
       (opt logic) check for file/directory existence

--ifexists
       (opt logic) check for file/directory existence

--if-plugin
       (opt logic) check for plugin

--if-not-plugin
       (opt logic) check for plugin

--ifplugin
       (opt logic) check for plugin

--if-file
       (opt logic) check for file existance

--if-not-file
       (opt logic) check for file existance

--if-dir
       (opt logic) check for directory existance

--if-not-dir
       (opt logic) check for directory existance

--ifdir
       (opt logic) check for directory existance

--if-directory
       (opt logic) check for directory existance

--endif
       (opt logic) end if

--end-if
       (opt logic) end if

--blacklist
       set options blacklist context

--end-blacklist
       clear options blacklist context

--whitelist
       set options whitelist context

--end-whitelist
       clear options whitelist context

--ignore-sigpipe
       do not report (annoying) SIGPIPE

--ignore-write-errors
       do not report (annoying) write()/writev() errors

--write-errors-tolerance
       set the maximum number of allowed write errors (default: no tolerance)

--write-errors-exception-only
       only raise an exception on write errors giving control to the app itself

--disable-write-exception
       disable exception generation on write()/writev()

--inherit
       use the specified file as config template

--include
       include the specified file as immediate configuration

--inject-before
       inject a text file before the config file (advanced templating)

--inject-after
       inject a text file after the config file (advanced templating)

-d|--daemonize
       daemonize uWSGI

--daemonize2
       daemonize uWSGI after app loading

--stop stop an instance

--reload
       reload an instance

--pause
       pause an instance

--suspend
       suspend an instance

--resume
       resume an instance

--connect-and-read
       connect to a socket and wait for data from it

--extract
       fetch/dump any supported address to stdout

-l|--listen
       set the socket listen queue size

-v|--max-vars
       set the amount of internal iovec/vars structures

--max-apps
       set the maximum number of per-worker applications

-b|--buffer-size
       set internal buffer size

-m|--memory-report
       enable memory report

--profiler
       enable the specified profiler

-c|--cgi-mode
       force CGI-mode for plugins supporting it

-a|--abstract-socket
       force UNIX socket in abstract mode (Linux only)

-C|--chmod-socket
       chmod-socket

-C|--chmod
       chmod-socket

--chown-socket
       chown unix sockets

--umask
       set umask

--freebind
       put socket in freebind mode

--map-socket
       map sockets to specific workers

-T|--enable-threads
       enable threads

--no-threads-wait
       do not wait for threads cancellation on quit/reload

--auto-procname
       automatically set processes name to something meaningful

--procname-prefix
       add a prefix to the process names

--procname-prefix-spaced
       add a spaced prefix to the process names

--procname-append
       append a string to process names

--procname
       set process names

--procname-master
       set master process name

-i|--single-interpreter
       do not use multiple interpreters (where available)

--need-app
       exit if no app can be loaded

-M|--master
       enable master process

--honour-stdin
       do not remap stdin to /dev/null

--emperor
       run the Emperor

--emperor-proxy-socket
       force the vassal to became an Emperor proxy

--emperor-wrapper
       set a binary wrapper for vassals

--emperor-wrapper-override
       set a binary wrapper for vassals to try before the default one

--emperor-wrapper-fallback
       set a binary wrapper for vassals to try as a last resort

--emperor-nofollow
       do not follow symlinks when checking for mtime

--emperor-procname
       set the Emperor process name

--emperor-freq
       set the Emperor scan frequency (default 3 seconds)

--emperor-required-heartbeat
       set the Emperor tolerance about heartbeats

--emperor-curse-tolerance
       set the Emperor tolerance about cursed vassals

--emperor-pidfile
       write the Emperor pid in the specified file

--emperor-tyrant
       put the Emperor in Tyrant mode

--emperor-tyrant-nofollow
       do not follow symlinks when checking for uid/gid in Tyrant mode

--emperor-stats
       run the Emperor stats server

--emperor-stats-server
       run the Emperor stats server

--early-emperor
       spawn the emperor as soon as possibile

--emperor-broodlord
       run the emperor in BroodLord mode

--emperor-throttle
       set throttling level (in milliseconds) for bad behaving vassals (default 1000)

--emperor-max-throttle
       set max throttling level (in milliseconds) for bad behaving vassals (default 3 minutes)

--emperor-magic-exec
       prefix vassals config files with exec:// if they have the executable bit

--emperor-on-demand-extension
       search for text file (vassal name + extension) containing the on demand socket name

--emperor-on-demand-ext
       search for text file (vassal name + extension) containing the on demand socket name

--emperor-on-demand-directory
       enable on demand mode binding to the unix socket in the specified  directory  named  like
       the vassal + .socket

--emperor-on-demand-dir
       enable  on  demand  mode binding to the unix socket in the specified directory named like
       the vassal + .socket

--emperor-on-demand-exec
       use the output of the specified command as on demand socket  name  (the  vassal  name  is
       passed as the only argument)

--emperor-extra-extension
       allows the specified extension in the Emperor (vassal will be called with --config)

--emperor-extra-ext
       allows the specified extension in the Emperor (vassal will be called with --config)

--emperor-no-blacklist
       disable Emperor blacklisting subsystem

--emperor-use-clone
       use clone() instead of fork() passing the specified unshare() flags

--emperor-cap
       set vassals capability

--vassals-cap
       set vassals capability

--vassal-cap
       set vassals capability

--imperial-monitor-list
       list enabled imperial monitors

--imperial-monitors-list
       list enabled imperial monitors

--vassals-inherit
       add config templates to vassals config (uses --inherit)

--vassals-include
       include config templates to vassals config (uses --include instead of --inherit)

--vassals-inherit-before
       add config templates to vassals config (uses --inherit, parses before the vassal file)

--vassals-include-before
       include  config  templates to vassals config (uses --include instead of --inherit, parses
       before the vassal file)

--vassals-start-hook
       run the specified command before each vassal starts

--vassals-stop-hook
       run the specified command after vassal's death

--vassal-sos
       ask emperor for reinforcement when overloaded

--vassal-sos-backlog
       ask emperor for sos if backlog queue has more items than the value specified

--vassals-set
       automatically set the specified option (via --set) for every vassal

--vassal-set
       automatically set the specified option (via --set) for every vassal

--heartbeat
       announce healthiness to the emperor

--reload-mercy
       set the maximum time (in seconds) we wait for workers and other processes to  die  during
       reload/shutdown

--worker-reload-mercy
       set the maximum time (in seconds) a worker can take to reload/shutdown (default is 60)

--mule-reload-mercy
       set the maximum time (in seconds) a mule can take to reload/shutdown (default is 60)

--exit-on-reload
       force exit even if a reload is requested

--die-on-term
       exit instead of brutal reload on SIGTERM

--force-gateway
       force the spawn of the first registered gateway without a master

-h|--help
       show this help

-h|--usage
       show this help

--print-sym
       print content of the specified binary symbol

--print-symbol
       print content of the specified binary symbol

-r|--reaper
       call waitpid(-1,...) after each request to get rid of zombies

-R|--max-requests
       reload workers after the specified amount of managed requests

--min-worker-lifetime
       number of seconds worker must run before being reloaded (default is 60)

--max-worker-lifetime
       reload workers after the specified amount of seconds (default is disabled)

-z|--socket-timeout
       set internal sockets timeout

--no-fd-passing
       disable file descriptor passing

--locks
       create the specified number of shared locks

--lock-engine
       set the lock engine

--ftok set the ipcsem key via ftok() for avoiding duplicates

--persistent-ipcsem
       do not remove ipcsem's on shutdown

-A|--sharedarea
       create a raw shared memory area of specified pages (note: it supports keyval too)

--safe-fd
       do not close the specified file descriptor

--fd-safe
       do not close the specified file descriptor

--cache
       create a shared cache containing given elements

--cache-blocksize
       set cache blocksize

--cache-store
       enable persistent cache to disk

--cache-store-sync
       set frequency of sync for persistent cache

--cache-no-expire
       disable auto sweep of expired items

--cache-expire-freq
       set the frequency of cache sweeper scans (default 3 seconds)

--cache-report-freed-items
       constantly report the cache item freed by the sweeper (use only for debug)

--cache-udp-server
       bind the cache udp server (used only for set/update/delete) to the specified socket

--cache-udp-node
       send cache update/deletion to the specified cache udp server

--cache-sync
       copy the whole content of another uWSGI cache server on server startup

--cache-use-last-modified
       update last_modified_at timestamp on every cache item modification (default is disabled)

--add-cache-item
       add an item in the cache

--load-file-in-cache
       load a static file in the cache

--load-file-in-cache-gzip
       load a static file in the cache with gzip compression

--cache2
       create a new generation shared cache (keyval syntax)

--queue
       enable shared queue

--queue-blocksize
       set queue blocksize

--queue-store
       enable persistent queue to disk

--queue-store-sync
       set frequency of sync for persistent queue

-Q|--spooler
       run a spooler on the specified directory

--spooler-external
       map spoolers requests to a spooler directory managed by an external instance

--spooler-ordered
       try to order the execution of spooler tasks

--spooler-chdir
       chdir() to specified directory before each spooler task

--spooler-processes
       set the number of processes for spoolers

--spooler-quiet
       do not be verbose with spooler tasks

--spooler-max-tasks
       set the maximum number of tasks to run before recycling a spooler

--spooler-harakiri
       set harakiri timeout for spooler tasks

--spooler-frequency
       set spooler frequency

--spooler-freq
       set spooler frequency

--mule add a mule

--mules
       add the specified number of mules

--farm add a mule farm

--mule-msg-size
       set mule message buffer size

--signal
       send a uwsgi signal to a server

--signal-bufsize
       set buffer size for signal queue

--signals-bufsize
       set buffer size for signal queue

--signal-timer
       add a timer (syntax: <signal> <seconds>)

--timer
       add a timer (syntax: <signal> <seconds>)

--signal-rbtimer
       add a redblack timer (syntax: <signal> <seconds>)

--rbtimer
       add a redblack timer (syntax: <signal> <seconds>)

--rpc-max
       maximum number of rpc slots (default: 64)

-L|--disable-logging
       disable request logging

--flock
       lock the specified file before starting, exit if locked

--flock-wait
       lock the specified file before starting, wait if locked

--flock2
       lock the specified file after logging/daemon setup, exit if locked

--flock-wait2
       lock the specified file after logging/daemon setup, wait if locked

--pidfile
       create pidfile (before privileges drop)

--pidfile2
       create pidfile (after privileges drop)

--chroot
       chroot() to the specified directory

--pivot-root
       pivot_root()  to the specified directories (new_root and put_old must be separated with a
       space)

--pivot_root
       pivot_root() to the specified directories (new_root and put_old must be separated with  a
       space)

--uid  setuid to the specified user/uid

--gid  setgid to the specified group/gid

--add-gid
       add the specified group id to the process credentials

--immediate-uid
       setuid to the specified user/uid IMMEDIATELY

--immediate-gid
       setgid to the specified group/gid IMMEDIATELY

--no-initgroups
       disable additional groups set via initgroups()

--cap  set process capability

--unshare
       unshare() part of the processes and put it in a new namespace

--unshare2
       unshare() part of the processes and put it in a new namespace after rootfs change

--setns-socket
       expose a unix socket returning namespace fds from /proc/self/ns

--setns-socket-skip
       skip the specified entry when sending setns file descriptors

--setns-skip
       skip the specified entry when sending setns file descriptors

--setns
       join a namespace created by an external uWSGI instance

--setns-preopen
       open /proc/self/ns as soon as possible and cache fds

--jailed
       mark the instance as jailed (force the execution of post_jail hooks)

--refork
       fork() again after privileges drop. Useful for jailing systems

--re-fork
       fork() again after privileges drop. Useful for jailing systems

--refork-as-root
       fork() again before privileges drop. Useful for jailing systems

--re-fork-as-root
       fork() again before privileges drop. Useful for jailing systems

--refork-post-jail
       fork() again after jailing. Useful for jailing systems

--re-fork-post-jail
       fork() again after jailing. Useful for jailing systems

--hook-asap
       run the specified hook as soon as possible

--hook-pre-jail
       run the specified hook before jailing

--hook-post-jail
       run the specified hook after jailing

--hook-in-jail
       run the specified hook in jail after initialization

--hook-as-root
       run the specified hook before privileges drop

--hook-as-user
       run the specified hook after privileges drop

--hook-as-user-atexit
       run the specified hook before app exit and reload

--hook-pre-app
       run the specified hook before app loading

--hook-post-app
       run the specified hook after app loading

--hook-post-fork
       run the specified hook after each fork

--hook-accepting
       run the specified hook after each worker enter the accepting phase

--hook-accepting1
       run the specified hook after the first worker enters the accepting phase

--hook-accepting-once
       run the specified hook after each worker enter the accepting phase (once per-instance)

--hook-accepting1-once
       run  the  specified  hook  after  the  first  worker enters the accepting phase (once per
       instance)

--hook-master-start
       run the specified hook when the Master starts

--hook-touch
       run the specified hook when the specified file is touched (syntax: <file> <action>)

--hook-emperor-start
       run the specified hook when the Emperor starts

--hook-emperor-stop
       run the specified hook when the Emperor send a stop message

--hook-emperor-reload
       run the specified hook when the Emperor send a reload message

--hook-emperor-lost
       run the specified hook when the Emperor connection is lost

--hook-as-vassal
       run the specified hook before exec()ing the vassal

--hook-as-emperor
       run the specified hook in the emperor after the vassal has been started

--hook-as-mule
       run the specified hook in each mule

--hook-as-gateway
       run the specified hook in each gateway

--after-request-hook
       run the specified function/symbol after each request

--after-request-call
       run the specified function/symbol after each request

--exec-asap
       run the specified command as soon as possible

--exec-pre-jail
       run the specified command before jailing

--exec-post-jail
       run the specified command after jailing

--exec-in-jail
       run the specified command in jail after initialization

--exec-as-root
       run the specified command before privileges drop

--exec-as-user
       run the specified command after privileges drop

--exec-as-user-atexit
       run the specified command before app exit and reload

--exec-pre-app
       run the specified command before app loading

--exec-post-app
       run the specified command after app loading

--exec-as-vassal
       run the specified command before exec()ing the vassal

--exec-as-emperor
       run the specified command in the emperor after the vassal has been started

--mount-asap
       mount filesystem as soon as possible

--mount-pre-jail
       mount filesystem before jailing

--mount-post-jail
       mount filesystem after jailing

--mount-in-jail
       mount filesystem in jail after initialization

--mount-as-root
       mount filesystem before privileges drop

--mount-as-vassal
       mount filesystem before exec()ing the vassal

--mount-as-emperor
       mount filesystem in the emperor after the vassal has been started

--umount-asap
       unmount filesystem as soon as possible

--umount-pre-jail
       unmount filesystem before jailing

--umount-post-jail
       unmount filesystem after jailing

--umount-in-jail
       unmount filesystem in jail after initialization

--umount-as-root
       unmount filesystem before privileges drop

--umount-as-vassal
       unmount filesystem before exec()ing the vassal

--umount-as-emperor
       unmount filesystem in the emperor after the vassal has been started

--wait-for-interface
       wait for the specified network interface to come up before running root hooks

--wait-for-interface-timeout
       set the timeout for wait-for-interface

--wait-interface
       wait for the specified network interface to come up before running root hooks

--wait-interface-timeout
       set the timeout for wait-for-interface

--wait-for-iface
       wait for the specified network interface to come up before running root hooks

--wait-for-iface-timeout
       set the timeout for wait-for-interface

--wait-iface
       wait for the specified network interface to come up before running root hooks

--wait-iface-timeout
       set the timeout for wait-for-interface

--wait-for-fs
       wait for the specified filesystem item to appear before running root hooks

--wait-for-file
       wait for the specified file to appear before running root hooks

--wait-for-dir
       wait for the specified directory to appear before running root hooks

--wait-for-mountpoint
       wait for the specified mountpoint to appear before running root hooks

--wait-for-fs-timeout
       set the timeout for wait-for-fs/file/dir

--wait-for-socket
       wait for the specified socket to be ready before loading apps

--wait-for-socket-timeout
       set the timeout for wait-for-socket

--call-asap
       call the specified function as soon as possible

--call-pre-jail
       call the specified function before jailing

--call-post-jail
       call the specified function after jailing

--call-in-jail
       call the specified function in jail after initialization

--call-as-root
       call the specified function before privileges drop

--call-as-user
       call the specified function after privileges drop

--call-as-user-atexit
       call the specified function before app exit and reload

--call-pre-app
       call the specified function before app loading

--call-post-app
       call the specified function after app loading

--call-as-vassal
       call the specified function() before exec()ing the vassal

--call-as-vassal1
       call the specified function(char *) before exec()ing the vassal

--call-as-vassal3
       call the specified function(char *, uid_t, gid_t) before exec()ing the vassal

--call-as-emperor
       call the specified function() in the emperor after the vassal has been started

--call-as-emperor1
       call the specified function(char *) in the emperor after the vassal has been started

--call-as-emperor2
       call the specified function(char *, pid_t) in the  emperor  after  the  vassal  has  been
       started

--call-as-emperor4
       call  the specified function(char *, pid_t, uid_t, gid_t) in the emperor after the vassal
       has been started

--ini  load config from ini file

-y|--yaml
       load config from yaml file

-y|--yml
       load config from yaml file

-j|--json
       load config from json file

-j|--js
       load config from json file

--weight
       weight of the instance (used by clustering/lb/subscriptions)

--auto-weight
       set weight of the instance (used by clustering/lb/subscriptions) automatically

--no-server
       force no-server mode

--command-mode
       force command mode

--no-defer-accept
       disable deferred-accept on sockets

--tcp-nodelay
       enable TCP NODELAY on each request

--so-keepalive
       enable TCP KEEPALIVEs

--so-send-timeout
       set SO_SNDTIMEO

--socket-send-timeout
       set SO_SNDTIMEO

--so-write-timeout
       set SO_SNDTIMEO

--socket-write-timeout
       set SO_SNDTIMEO

--socket-sndbuf
       set SO_SNDBUF

--socket-rcvbuf
       set SO_RCVBUF

--limit-as
       limit processes address space/vsz

--limit-nproc
       limit the number of spawnable processes

--reload-on-as
       reload if address space is higher than specified megabytes

--reload-on-rss
       reload if rss memory is higher than specified megabytes

--evil-reload-on-as
       force the master to reload a worker  if  its  address  space  is  higher  than  specified
       megabytes

--evil-reload-on-rss
       force the master to reload a worker if its rss memory is higher than specified megabytes

--mem-collector-freq
       set the memory collector frequency when evil reloads are in place

--reload-on-fd
       reload if the specified file descriptor is ready

--brutal-reload-on-fd
       brutal reload if the specified file descriptor is ready

--ksm  enable Linux KSM

--pcre-jit
       enable pcre jit (if available)

--never-swap
       lock all memory pages avoiding swapping

--touch-reload
       reload uWSGI if the specified file is modified/touched

--touch-workers-reload
       trigger reload of (only) workers if the specified file is modified/touched

--touch-mules-reload
       reload mules if the specified file is modified/touched

--touch-spoolers-reload
       reload spoolers if the specified file is modified/touched

--touch-chain-reload
       trigger chain reload if the specified file is modified/touched

--touch-logrotate
       trigger logrotation if the specified file is modified/touched

--touch-logreopen
       trigger log reopen if the specified file is modified/touched

--touch-exec
       run command when the specified file is modified/touched (syntax: file command)

--touch-signal
       signal when the specified file is modified/touched (syntax: file signal)

--fs-reload
       graceful reload when the specified filesystem object is modified

--fs-brutal-reload
       brutal reload when the specified filesystem object is modified

--fs-signal
       raise  a uwsgi signal when the specified filesystem object is modified (syntax: file sig‐
       nal)

--check-mountpoint
       destroy the instance if a filesystem is no more reachable (useful for reliable Fuse  man‐
       agement)

--mountpoint-check
       destroy  the instance if a filesystem is no more reachable (useful for reliable Fuse man‐
       agement)

--check-mount
       destroy the instance if a filesystem is no more reachable (useful for reliable Fuse  man‐
       agement)

--mount-check
       destroy  the instance if a filesystem is no more reachable (useful for reliable Fuse man‐
       agement)

--propagate-touch
       over-engineering option for system with flaky signal management

--limit-post
       limit request body

--no-orphans
       automatically kill workers if master dies (can be dangerous for availability)

--prio set processes/threads priority

--cpu-affinity
       set cpu affinity

--post-buffering
       set size in bytes after which will buffer to disk instead of memory

--post-buffering-bufsize
       set buffer size for read() in post buffering mode

--body-read-warning
       set the amount of allowed memory allocation (in megabytes) for request body before start‐
       ing printing a warning

--upload-progress
       enable creation of .json files in the specified directory during a file upload

--no-default-app
       do not fallback to default app

--manage-script-name
       automatically rewrite SCRIPT_NAME and PATH_INFO

--ignore-script-name
       ignore SCRIPT_NAME

--catch-exceptions
       report exception as http output (discouraged, use only for testing)

--reload-on-exception
       reload a worker when an exception is raised

--reload-on-exception-type
       reload a worker when a specific exception type is raised

--reload-on-exception-value
       reload a worker when a specific exception value is raised

--reload-on-exception-repr
       reload a worker when a specific exception type+value (language-specific) is raised

--exception-handler
       add an exception handler

--enable-metrics
       enable metrics subsystem

--metric
       add a custom metric

--metric-threshold
       add a metric threshold/alarm

--metric-alarm
       add a metric threshold/alarm

--alarm-metric
       add a metric threshold/alarm

--metrics-dir
       export metrics as text files to the specified directory

--metrics-dir-restore
       restore last value taken from the metrics dir

--metric-dir
       export metrics as text files to the specified directory

--metric-dir-restore
       restore last value taken from the metrics dir

--metrics-no-cores
       disable generation of cores-related metrics

--udp  run the udp server on the specified address

--stats
       enable the stats server on the specified address

--stats-server
       enable the stats server on the specified address

--stats-http
       prefix stats server json output with http headers

--stats-minified
       minify statistics json output

--stats-min
       minify statistics json output

--stats-push
       push the stats json to the specified destination

--stats-pusher-default-freq
       set the default frequency of stats pushers

--stats-pushers-default-freq
       set the default frequency of stats pushers

--stats-no-cores
       disable generation of cores-related stats

--stats-no-metrics
       do not include metrics in stats output

--multicast
       subscribe to specified multicast group

--multicast-ttl
       set multicast ttl

--multicast-loop
       set multicast loop (default 1)

--master-fifo
       enable the master fifo

--notify-socket
       enable the notification socket

--subscription-notify-socket
       set the notification socket for subscriptions

--legion
       became a member of a legion

--legion-mcast
       became a member of a legion (shortcut for multicast)

--legion-node
       add a node to a legion

--legion-freq
       set the frequency of legion packets

--legion-tolerance
       set the tolerance of legion subsystem

--legion-death-on-lord-error
       declare  itself  as  a  dead  node for the specified amount of seconds if one of the lord
       hooks fails

--legion-skew-tolerance
       set the clock skew tolerance of legion subsystem (default 30 seconds)

--legion-lord
       action to call on Lord election

--legion-unlord
       action to call on Lord dismiss

--legion-setup
       action to call on legion setup

--legion-death
       action to call on legion death (shutdown of the instance)

--legion-join
       action to call on legion join (first time quorum is reached)

--legion-node-joined
       action to call on new node joining legion

--legion-node-left
       action to call node leaving legion

--legion-quorum
       set the quorum of a legion

--legion-scroll
       set the scroll of a legion

--legion-scroll-max-size
       set max size of legion scroll buffer

--legion-scroll-list-max-size
       set max size of legion scroll list buffer

--subscriptions-sign-check
       set digest algorithm and certificate directory for secured subscription system

--subscriptions-sign-check-tolerance
       set the maximum tolerance (in seconds) of clock skew for secured subscription system

--subscriptions-sign-skip-uid
       skip signature check for the specified uid when using unix sockets credentials

--subscriptions-credentials-check
       add a directory to search for subscriptions key credentials

--subscriptions-use-credentials
       enable management of SCM_CREDENTIALS in subscriptions UNIX sockets

--subscription-algo
       set load balancing algorithm for the subscription system

--subscription-dotsplit
       try to fallback to the next part (dot based) in subscription key

--subscribe-to
       subscribe to the specified subscription server

--st   subscribe to the specified subscription server

--subscribe
       subscribe to the specified subscription server

--subscribe2
       subscribe to the specified subscription server using advanced keyval syntax

--subscribe-freq
       send subscription announce at the specified interval

--subscription-tolerance
       set tolerance for subscription servers

--unsubscribe-on-graceful-reload
       force unsubscribe request even during graceful reload

--start-unsubscribed
       configure subscriptions but do not send them (useful with master fifo)

--subscribe-with-modifier1
       force the specififed modifier1 when subscribing

--snmp enable the embedded snmp server

--snmp-community
       set the snmp community string

--ssl-verbose
       be verbose about SSL errors

--sni  add an SNI-governed SSL context

--sni-dir
       check for cert/key/client_ca file in the specified directory and create a sni/ssl context
       on demand

--sni-dir-ciphers
       set ssl ciphers for sni-dir option

--ssl-enable3
       enable SSLv3 (insecure)

--ssl-option
       set a raw ssl option (numeric value)

--sni-regexp
       add an SNI-governed SSL context (the key is a regexp)

--ssl-tmp-dir
       store ssl-related temp files in the specified directory

--check-interval
       set the interval (in seconds) of master checks

--forkbomb-delay
       sleep for the specified number of seconds when a forkbomb is detected

--binary-path
       force binary path

--privileged-binary-patch
       patch the uwsgi binary with a new command (before privileges drop)

--unprivileged-binary-patch
       patch the uwsgi binary with a new command (after privileges drop)

--privileged-binary-patch-arg
       patch the uwsgi binary with a new command and arguments (before privileges drop)

--unprivileged-binary-patch-arg
       patch the uwsgi binary with a new command and arguments (after privileges drop)

--async
       enable async mode with specified cores

--max-fd
       set maximum number of file descriptors (requires root privileges)

--logto
       set logfile/udp address

--logto2
       log to specified file or udp address after privileges drop

--log-format
       set advanced format for request logging

--logformat
       set advanced format for request logging

--logformat-strftime
       apply strftime to logformat output

--log-format-strftime
       apply strftime to logformat output

--logfile-chown
       chown logfiles

--logfile-chmod
       chmod logfiles

--log-syslog
       log to syslog

--log-socket
       send logs to the specified socket

--req-logger
       set/append a request logger

--logger-req
       set/append a request logger

--logger
       set/append a logger

--logger-list
       list enabled loggers

--loggers-list
       list enabled loggers

--threaded-logger
       offload log writing to a thread

--log-encoder
       add an item in the log encoder chain

--log-req-encoder
       add an item in the log req encoder chain

--log-drain
       drain (do not show) log lines matching the specified regexp

--log-filter
       show only log lines matching the specified regexp

--log-route
       log to the specified named logger if regexp applied on logline matches

--log-req-route
       log requests to the specified named logger if regexp applied on logline matches

--use-abort
       call abort() on segfault/fpe, could be useful for generating a core dump

--alarm
       create a new alarm, syntax: <alarm> <plugin:args>

--alarm-cheap
       use main alarm thread rather than create dedicated threads for curl-based alarms

--alarm-freq
       tune the anti-loop alarm system (default 3 seconds)

--alarm-fd
       raise  the specified alarm when an fd is read for read (by default it reads 1 byte, set 8
       for eventfd)

--alarm-segfault
       raise the specified alarm when the segmentation fault handler is executed

--segfault-alarm
       raise the specified alarm when the segmentation fault handler is executed

--alarm-backlog
       raise the specified alarm when the socket backlog queue is full

--backlog-alarm
       raise the specified alarm when the socket backlog queue is full

--lq-alarm
       raise the specified alarm when the socket backlog queue is full

--alarm-lq
       raise the specified alarm when the socket backlog queue is full

--alarm-listen-queue
       raise the specified alarm when the socket backlog queue is full

--listen-queue-alarm
       raise the specified alarm when the socket backlog queue is full

--log-alarm
       raise the specified  alarm  when  a  log  line  matches  the  specified  regexp,  syntax:
       <alarm>[,alarm...] <regexp>

--alarm-log
       raise  the  specified  alarm  when  a  log  line  matches  the  specified regexp, syntax:
       <alarm>[,alarm...] <regexp>

--not-log-alarm
       skip the  specified  alarm  when  a  log  line  matches  the  specified  regexp,  syntax:
       <alarm>[,alarm...] <regexp>

--not-alarm-log
       skip  the  specified  alarm  when  a  log  line  matches  the  specified  regexp, syntax:
       <alarm>[,alarm...] <regexp>

--alarm-list
       list enabled alarms

--alarms-list
       list enabled alarms

--alarm-msg-size
       set the max size of an alarm message (default 8192)

--log-master
       delegate logging to master process

--log-master-bufsize
       set the buffer size for the master logger. bigger log messages will be truncated

--log-master-stream
       create the master logpipe as SOCK_STREAM

--log-master-req-stream
       create the master requests logpipe as SOCK_STREAM

--log-reopen
       reopen log after reload

--log-truncate
       truncate log on startup

--log-maxsize
       set maximum logfile size

--log-backupname
       set logfile name after rotation

--logdate
       prefix logs with date or a strftime string

--log-date
       prefix logs with date or a strftime string

--log-prefix
       prefix logs with a string

--log-zero
       log responses without body

--log-slow
       log requests slower than the specified number of milliseconds

--log-4xx
       log requests with a 4xx response

--log-5xx
       log requests with a 5xx response

--log-big
       log requestes bigger than the specified size

--log-sendfile
       log sendfile requests

--log-ioerror
       log requests with io errors

--log-micros
       report response time in microseconds instead of milliseconds

--log-x-forwarded-for
       use the ip from X-Forwarded-For header instead of REMOTE_ADDR

--master-as-root
       leave master process running as root

--drop-after-init
       run privileges drop after plugin initialization, superseded by drop-after-apps

--drop-after-apps
       run privileges drop after apps loading, superseded by master-as-root

--force-cwd
       force the initial working directory to the specified value

--binsh
       override /bin/sh (used by exec hooks, it always fallback to /bin/sh)

--chdir
       chdir to specified directory before apps loading

--chdir2
       chdir to specified directory after apps loading

--lazy set lazy mode (load apps in workers instead of master)

--lazy-apps
       load apps in each worker instead of the master

--cheap
       set cheap mode (spawn workers only after the first request)

--cheaper
       set cheaper mode (adaptive process spawning)

--cheaper-initial
       set the initial number of processes to spawn in cheaper mode

--cheaper-algo
       choose to algorithm used for adaptive process spawning

--cheaper-step
       number of additional processes to spawn at each overload

--cheaper-overload
       increase workers after specified overload

--cheaper-algo-list
       list enabled cheapers algorithms

--cheaper-algos-list
       list enabled cheapers algorithms

--cheaper-list
       list enabled cheapers algorithms

--cheaper-rss-limit-soft
       don't spawn new workers if total resident memory usage of all workers is higher than this
       limit

--cheaper-rss-limit-hard
       if total workers resident memory usage is higher try to stop workers

--idle set idle mode (put uWSGI in cheap mode after inactivity)

--die-on-idle
       shutdown uWSGI when idle

--mount
       load application under mountpoint

--worker-mount
       load application under mountpoint in the specified worker or after workers spawn

--threads
       run each worker in prethreaded mode with the specified number of threads

--thread-stacksize
       set threads stacksize

--threads-stacksize
       set threads stacksize

--thread-stack-size
       set threads stacksize

--threads-stack-size
       set threads stacksize

--vhost
       enable virtualhosting mode (based on SERVER_NAME variable)

--vhost-host
       enable virtualhosting mode (based on HTTP_HOST variable)

--route
       add a route

--route-host
       add a route based on Host header

--route-uri
       add a route based on REQUEST_URI

--route-qs
       add a route based on QUERY_STRING

--route-remote-addr
       add a route based on REMOTE_ADDR

--route-user-agent
       add a route based on HTTP_USER_AGENT

--route-remote-user
       add a route based on REMOTE_USER

--route-referer
       add a route based on HTTP_REFERER

--route-label
       add a routing label (for use with goto)

--route-if
       add a route based on condition

--route-if-not
       add a route based on condition (negate version)

--route-run
       always run the specified route action

--final-route
       add a final route

--final-route-status
       add a final route for the specified status

--final-route-host
       add a final route based on Host header

--final-route-uri
       add a final route based on REQUEST_URI

--final-route-qs
       add a final route based on QUERY_STRING

--final-route-remote-addr
       add a final route based on REMOTE_ADDR

--final-route-user-agent
       add a final route based on HTTP_USER_AGENT

--final-route-remote-user
       add a final route based on REMOTE_USER

--final-route-referer
       add a final route based on HTTP_REFERER

--final-route-label
       add a final routing label (for use with goto)

--final-route-if
       add a final route based on condition

--final-route-if-not
       add a final route based on condition (negate version)

--final-route-run
       always run the specified final route action

--error-route
       add an error route

--error-route-status
       add an error route for the specified status

--error-route-host
       add an error route based on Host header

--error-route-uri
       add an error route based on REQUEST_URI

--error-route-qs
       add an error route based on QUERY_STRING

--error-route-remote-addr
       add an error route based on REMOTE_ADDR

--error-route-user-agent
       add an error route based on HTTP_USER_AGENT

--error-route-remote-user
       add an error route based on REMOTE_USER

--error-route-referer
       add an error route based on HTTP_REFERER

--error-route-label
       add an error routing label (for use with goto)

--error-route-if
       add an error route based on condition

--error-route-if-not
       add an error route based on condition (negate version)

--error-route-run
       always run the specified error route action

--response-route
       add a response route

--response-route-status
       add a response route for the specified status

--response-route-host
       add a response route based on Host header

--response-route-uri
       add a response route based on REQUEST_URI

--response-route-qs
       add a response route based on QUERY_STRING

--response-route-remote-addr
       add a response route based on REMOTE_ADDR

--response-route-user-agent
       add a response route based on HTTP_USER_AGENT

--response-route-remote-user
       add a response route based on REMOTE_USER

--response-route-referer
       add a response route based on HTTP_REFERER

--response-route-label
       add a response routing label (for use with goto)

--response-route-if
       add a response route based on condition

--response-route-if-not
       add a response route based on condition (negate version)

--response-route-run
       always run the specified response route action

--router-list
       list enabled routers

--routers-list
       list enabled routers

--error-page-403
       add an error page (html) for managed 403 response

--error-page-404
       add an error page (html) for managed 404 response

--error-page-500
       add an error page (html) for managed 500 response

--websockets-ping-freq
       set the frequency (in seconds) of websockets automatic ping packets

--websocket-ping-freq
       set the frequency (in seconds) of websockets automatic ping packets

--websockets-pong-tolerance
       set the tolerance (in seconds) of websockets ping/pong subsystem

--websocket-pong-tolerance
       set the tolerance (in seconds) of websockets ping/pong subsystem

--websockets-max-size
       set the max allowed size of websocket messages (in Kbytes, default 1024)

--websocket-max-size
       set the max allowed size of websocket messages (in Kbytes, default 1024)

--chunked-input-limit
       set the max size of a chunked input part (default 1MB, in bytes)

--chunked-input-timeout
       set default timeout for chunked input

--clock
       set a clock source

--clock-list
       list enabled clocks

--clocks-list
       list enabled clocks

--add-header
       automatically add HTTP headers to response

--rem-header
       automatically remove specified HTTP header from the response

--del-header
       automatically remove specified HTTP header from the response

--collect-header
       store the specified response header in a request var (syntax: header var)

--response-header-collect
       store the specified response header in a request var (syntax: header var)

--pull-header
       store  the  specified  response  header  in a request var and remove it from the response
       (syntax: header var)

--check-static
       check for static files in the specified directory

--check-static-docroot
       check for static files in the requested DOCUMENT_ROOT

--static-check
       check for static files in the specified directory

--static-map
       map mountpoint to static directory (or file)

--static-map2
       like static-map but completely appending the requested resource to the docroot

--static-skip-ext
       skip specified extension from staticfile checks

--static-index
       search for specified file if a directory is requested

--static-safe
       skip security checks if the file is under the specified path

--static-cache-paths
       put resolved paths in the uWSGI cache for the specified amount of seconds

--static-cache-paths-name
       use the specified cache for static paths

--mimefile
       set mime types file path (default /etc/mime.types)

--mime-file
       set mime types file path (default /etc/mime.types)

--static-expires-type
       set the Expires header based on content type

--static-expires-type-mtime
       set the Expires header based on content type and file mtime

--static-expires
       set the Expires header based on filename regexp

--static-expires-mtime
       set the Expires header based on filename regexp and file mtime

--static-expires-uri
       set the Expires header based on REQUEST_URI regexp

--static-expires-uri-mtime
       set the Expires header based on REQUEST_URI regexp and file mtime

--static-expires-path-info
       set the Expires header based on PATH_INFO regexp

--static-expires-path-info-mtime
       set the Expires header based on PATH_INFO regexp and file mtime

--static-gzip
       if the supplied regexp matches the static file translation it will search for a gzip ver‐
       sion

--static-gzip-all
       check for a gzip version of all requested static files

--static-gzip-dir
       check for a gzip version of all requested static files in the specified dir/prefix

--static-gzip-prefix
       check for a gzip version of all requested static files in the specified dir/prefix

--static-gzip-ext
       check for a gzip version of all requested static files with the specified ext/suffix

--static-gzip-suffix
       check for a gzip version of all requested static files with the specified ext/suffix

--honour-range
       enable support for the HTTP Range header

--offload-threads
       set the number of offload threads to spawn (per-worker, default 0)

--offload-thread
       set the number of offload threads to spawn (per-worker, default 0)

--file-serve-mode
       set static file serving mode

--fileserve-mode
       set static file serving mode

--disable-sendfile
       disable sendfile() and rely on boring read()/write()

--check-cache
       check for response data in the specified cache (empty for default cache)

--close-on-exec
       set  close-on-exec  on  connection  sockets  (could be required for spawning processes in
       requests)

--close-on-exec2
       set close-on-exec on  server  sockets  (could  be  required  for  spawning  processes  in
       requests)

--mode set uWSGI custom mode

--env  set environment variable

--envdir
       load a daemontools compatible envdir

--early-envdir
       load a daemontools compatible envdir ASAP

--unenv
       unset environment variable

--vacuum
       try to remove all of the generated file/sockets

--file-write
       write  the specified content to the specified file (syntax: file=value) before privileges
       drop

--cgroup
       put the processes in the specified cgroup

--cgroup-opt
       set value in specified cgroup option

--cgroup-dir-mode
       set permission for cgroup directory (default is 700)

--namespace
       run in a new namespace under the specified rootfs

--namespace-keep-mount
       keep the specified mountpoint in your namespace

--ns   run in a new namespace under the specified rootfs

--namespace-net
       add network namespace

--ns-net
       add network namespace

--enable-proxy-protocol
       enable PROXY1 protocol support (only for http parsers)

--reuse-port
       enable REUSE_PORT flag on socket (BSD only)

--tcp-fast-open
       enable TCP_FASTOPEN flag on TCP sockets with the specified qlen value

--tcp-fastopen
       enable TCP_FASTOPEN flag on TCP sockets with the specified qlen value

--tcp-fast-open-client
       use sendto(..., MSG_FASTOPEN, ...) instead of connect() if supported

--tcp-fastopen-client
       use sendto(..., MSG_FASTOPEN, ...) instead of connect() if supported

--zerg attach to a zerg server

--zerg-fallback
       fallback to normal sockets if the zerg server is not available

--zerg-server
       enable the zerg server on the specified UNIX socket

--cron add a cron task

--cron2
       add a cron task (key=val syntax)

--unique-cron
       add a unique cron task

--cron-harakiri
       set the maximum time (in seconds) we wait for cron command to complete

--legion-cron
       add a cron task runnable only when the instance is a lord of the specified legion

--cron-legion
       add a cron task runnable only when the instance is a lord of the specified legion

--unique-legion-cron
       add a unique cron task runnable only when the instance is a lord of the specified legion

--unique-cron-legion
       add a unique cron task runnable only when the instance is a lord of the specified legion

--loop select the uWSGI loop engine

--loop-list
       list enabled loop engines

--loops-list
       list enabled loop engines

--worker-exec
       run the specified command as worker

--worker-exec2
       run the specified command as worker (after post_fork hook)

--attach-daemon
       attach a command/daemon to the master process (the command has to not go in background)

--attach-control-daemon
       attach a command/daemon to the master process (the command has to not go in  background),
       when the daemon dies, the master dies too

--smart-attach-daemon
       attach  a  command/daemon  to the master process managed by a pidfile (the command has to
       daemonize)

--smart-attach-daemon2
       attach a command/daemon to the master process managed by a pidfile (the  command  has  to
       NOT daemonize)

--legion-attach-daemon
       same as --attach-daemon but daemon runs only on legion lord node

--legion-smart-attach-daemon
       same as --smart-attach-daemon but daemon runs only on legion lord node

--legion-smart-attach-daemon2
       same as --smart-attach-daemon2 but daemon runs only on legion lord node

--daemons-honour-stdin
       do not change the stdin of external daemons to /dev/null

--attach-daemon2
       attach-daemon keyval variant (supports smart modes too)

--plugins
       load uWSGI plugins

--plugin
       load uWSGI plugins

--need-plugins
       load uWSGI plugins (exit on error)

--need-plugin
       load uWSGI plugins (exit on error)

--plugins-dir
       add a directory to uWSGI plugin search path

--plugin-dir
       add a directory to uWSGI plugin search path

--plugins-list
       list enabled plugins

--plugin-list
       list enabled plugins

--autoload
       try to automatically load plugins when unknown options are found

--dlopen
       blindly load a shared library

--allowed-modifiers
       comma separated list of allowed modifiers

--remap-modifier
       remap request modifier from one id to another

--dump-options
       dump the full list of available options
       装在所有可用的选项

--show-config
       show the current config reformatted as ini
       显示当前重新初始化时的设置

--binary-append-data
       return  the  content of a resource to stdout for appending to a uwsgi binary (for data://usage)

--print
       simple print
       简易输出

--iprint
       simple print (immediate version)
       建议输出（当前生效）

--exit force exit() of the instance
       强制退出当前运行实例

--cflags
       report uWSGI CFLAGS (useful for building external plugins)
       创建拓展插件是报告uwsgi编译器选项

--dot-h
       dump the uwsgi.h used for building the core  (useful for building external plugins)
       创建时使用uwsgi.h

--config-py
       dump the uwsgiconfig.py used for building the core  (useful for building  external  plugins)
       创建时使用uwsgiconfig.py

--build-plugin
       build a uWSGI plugin for the current binary
       为当前的执行文件中创建一个uwsgi的插件，即加载插件到uwsgi服务器上

--version
       print uWSGI version
       查看当前uwsgi版本

os_help（已更新）

Help on module OS

MODULE REFERENCE

1
2
3
4
5
6
7
https://docs.python.org/3.7/library/os

The following documentation is automatically generated from the Python
source files.  It may be incomplete, incorrect or include features that
are considered implementation detail and may vary between Python
implementations.  When in doubt, consult the module reference at the
location listed above.

DESCRIPTION

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
This exports:
  - all functions from posix or nt, e.g. unlink, stat, etc.
  - os.path is either posixpath or ntpath
  - os.name is either 'posix' or 'nt'
  - os.curdir is a string representing the current directory (always '.')
  - os.pardir is a string representing the parent directory (always '..')
  - os.sep is the (or a most common) pathname separator ('/' or '\\')
  - os.extsep is the extension separator (always '.')
  - os.altsep is the alternate pathname separator (None or '/')
  - os.pathsep is the component separator used in $PATH etc
  - os.linesep is the line separator in text files ('\r' or '\n' or '\r\n')
  - os.defpath is the default search path for executables
  - os.devnull is the file path of the null device ('/dev/null', etc.)

Programs that import and use 'os' stand a better chance of being
portable between different platforms.  Of course, they must then
only use functions that are defined by all platforms (e.g., unlink
and opendir), and leave all pathname manipulation to os.path
(e.g., split and join).

CLASSES

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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
    builtins.Exception(builtins.BaseException)
        builtins.OSError
    builtins.object
        posix.DirEntry
    builtins.tuple(builtins.object)
        stat_result
        statvfs_result
        terminal_size
        posix.times_result
        posix.uname_result
    
    class DirEntry(builtins.object)
     |  Methods defined here:
     |  
     |  __fspath__(self, /)
     |      Returns the path for the entry.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  inode(self, /)
     |      Return inode of the entry; cached per entry.
     |  
     |  is_dir(self, /, *, follow_symlinks=True)
     |      Return True if the entry is a directory; cached per entry.
     |  
     |  is_file(self, /, *, follow_symlinks=True)
     |      Return True if the entry is a file; cached per entry.
     |  
     |  is_symlink(self, /)
     |      Return True if the entry is a symbolic link; cached per entry.
     |  
     |  stat(self, /, *, follow_symlinks=True)
     |      Return stat_result object for the entry; cached per entry.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  name
     |      the entry's base filename, relative to scandir() "path" argument
     |  
     |  path
     |      the entry's full path name; equivalent to os.path.join(scandir_path, entry.name)
    
    error = class OSError(Exception)
     |  Base class for I/O related errors.
     |  
     |  Method resolution order:
     |      OSError
     |      Exception
     |      BaseException
     |      object
     |  
     |  Methods defined here:
     |  
     |  __init__(self, /, *args, **kwargs)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __str__(self, /)
     |      Return str(self).
     |  
     |  ----------------------------------------------------------------------
     |  Static methods defined here:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  characters_written
     |  
     |  errno
     |      POSIX exception code
     |  
     |  filename
     |      exception filename
     |  
     |  filename2
     |      second exception filename
     |  
     |  strerror
     |      exception strerror
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from BaseException:
     |  
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |  
     |  __setstate__(...)
     |  
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from BaseException:
     |  
     |  __cause__
     |      exception cause
     |  
     |  __context__
     |      exception context
     |  
     |  __dict__
     |  
     |  __suppress_context__
     |  
     |  __traceback__
     |  
     |  args
    
    class stat_result(builtins.tuple)
     |  stat_result(iterable=(), /)
     |  
     |  stat_result: Result from stat, fstat, or lstat.
     |  
     |  This object may be accessed either as a tuple of
     |    (mode, ino, dev, nlink, uid, gid, size, atime, mtime, ctime)
     |  or via the attributes st_mode, st_ino, st_dev, st_nlink, st_uid, and so on.
     |  
     |  Posix/windows: If your platform supports st_blksize, st_blocks, st_rdev,
     |  or st_flags, they are available as attributes only.
     |  
     |  See os.stat for more information.
     |  
     |  Method resolution order:
     |      stat_result
     |      builtins.tuple
     |      builtins.object
     |  
     |  Methods defined here:
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  ----------------------------------------------------------------------
     |  Static methods defined here:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  st_atime
     |      time of last access
     |  
     |  st_atime_ns
     |      time of last access in nanoseconds
     |  
     |  st_birthtime
     |      time of creation
     |  
     |  st_blksize
     |      blocksize for filesystem I/O
     |  
     |  st_blocks
     |      number of blocks allocated
     |  
     |  st_ctime
     |      time of last change
     |  
     |  st_ctime_ns
     |      time of last change in nanoseconds
     |  
     |  st_dev
     |      device
     |  
     |  st_flags
     |      user defined flags for file
     |  
     |  st_gen
     |      generation number
     |  
     |  st_gid
     |      group ID of owner
     |  
     |  st_ino
     |      inode
     |  
     |  st_mode
     |      protection bits
     |  
     |  st_mtime
     |      time of last modification
     |  
     |  st_mtime_ns
     |      time of last modification in nanoseconds
     |  
     |  st_nlink
     |      number of hard links
     |  
     |  st_rdev
     |      device type (if inode device)
     |  
     |  st_size
     |      total size, in bytes
     |  
     |  st_uid
     |      user ID of owner
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |  
     |  n_fields = 22for NT or Posix depending on what system we're on.
     |  
     |  n_sequence_fields = 10
     |  s://docs.python.org/3.7/library/os
     |  n_unnamed_fields = 3
     |  following documentation is automatically generated from the Python
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.tuple:ay vary between Python
     |  ementations.  When in doubt, consult the module reference at the
     |  __add__(self, value, /)
     |      Return self+value.
     |  ION
     |  __contains__(self, key, /)
     |      Return key in self.x or nt, e.g. unlink, stat, etc.
     |  os.path is either posixpath or ntpath
     |  __eq__(self, value, /)ix' or 'nt'
     |      Return self==value.epresenting the current directory (always '.')
     |  os.pardir is a string representing the parent directory (always '..')
     |  __ge__(self, value, /)st common) pathname separator ('/' or '\\')
     |      Return self>=value.ion separator (always '.')
     |  os.altsep is the alternate pathname separator (None or '/')
     |  __getattribute__(self, name, /)arator used in $PATH etc
     |      Return getattr(self, name).r in text files ('\r' or '\n' or '\r\n')
     |  os.defpath is the default search path for executables
     |  __getitem__(self, key, /)th of the null device ('/dev/null', etc.)
     |      Return self[key].
     |  rams that import and use 'os' stand a better chance of being
     |  __getnewargs__(self, /)platforms.  Of course, they must then
     |   use functions that are defined by all platforms (e.g., unlink
     |  __gt__(self, value, /)l pathname manipulation to os.path
     |      Return self>value.
     |  
     |  __hash__(self, /)
     |      Return hash(self).s.BaseException)
     |  builtins.OSError
     |  __iter__(self, /)
     |      Implement iter(self).
     |  tins.tuple(builtins.object)
     |  __le__(self, value, /)
     |      Return self<=value.
     |  terminal_size
     |  __len__(self, /)lt
     |      Return len(self).
     |  
     |  __lt__(self, value, /)ject)
     |      Return self<value.
     |  
     |  __mul__(self, value, /)
     |      Return self*value.or the entry.
     |  
     |  __ne__(self, value, /)
     |      Return self!=value.
     |  
     |  __rmul__(self, value, /)
     |      Return value*self.e entry; cached per entry.
     |  
     |  count(self, value, /)
     |      Return number of occurrences of value.
     |  
     |  index(self, value, start=0, stop=9223372036854775807, /)
     |      Return first index of value.
     |      
     |      Raises ValueError if the value is not present.
    
    class statvfs_result(builtins.tuple)
     |  statvfs_result(iterable=(), /)
     |  
     |  statvfs_result: Result from statvfs or fstatvfs.
     |  
     |  This object may be accessed either as a tuple of
     |    (bsize, frsize, blocks, bfree, bavail, files, ffree, favail, flag, namemax),
     |  or via the attributes f_bsize, f_frsize, f_blocks, f_bfree, and so on.
     |  
     |  See os.statvfs for more information.
     |  
     |  Method resolution order:
     |      statvfs_result
     |      builtins.tuple
     |      builtins.object
     |  
     |  Methods defined here:
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  ----------------------------------------------------------------------
     |  Static methods defined here:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  f_bavail
     |  
     |  f_bfree
     |  
     |  f_blocks
     |  
     |  f_bsize
     |  
     |  f_favail
     |  
     |  f_ffree
     |  
     |  f_files
     |  
     |  f_flag
     |  
     |  f_frsize
     |  
     |  f_fsid
     |  
     |  f_namemax
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |  
     |  n_fields = 11
     |  
     |  n_sequence_fields = 10
     |  
     |  n_unnamed_fields = 0
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.tuple:
     |  
     |  __add__(self, value, /)
     |      Return self+value.
     |  
     |  __contains__(self, key, /)
     |      Return key in self.
     |  
     |  __eq__(self, value, /)
     |      Return self==value.
     |  
     |  __ge__(self, value, /)
     |      Return self>=value.
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __getitem__(self, key, /)
     |      Return self[key].
     |  
     |  __getnewargs__(self, /)
     |  
     |  __gt__(self, value, /)
     |      Return self>value.
     |  
     |  __hash__(self, /)
     |      Return hash(self).
     |  
     |  __iter__(self, /)
     |      Implement iter(self).
     |  
     |  __le__(self, value, /)
     |      Return self<=value.
     |  
     |  __len__(self, /)
     |      Return len(self).
     |  
     |  __lt__(self, value, /)
     |      Return self<value.
     |  
     |  __mul__(self, value, /)
     |      Return self*value.
     |  
     |  __ne__(self, value, /)
     |      Return self!=value.
     |  
     |  __rmul__(self, value, /)
     |      Return value*self.
     |  
     |  count(self, value, /)
     |      Return number of occurrences of value.
     |  
     |  index(self, value, start=0, stop=9223372036854775807, /)
     |      Return first index of value.
     |      
     |      Raises ValueError if the value is not present.
    
    class terminal_size(builtins.tuple)
     |  terminal_size(iterable=(), /)
     |  
     |  A tuple of (columns, lines) for holding terminal window size
     |  
     |  Method resolution order:
     |      terminal_size
     |      builtins.tuple
     |      builtins.object
     |  
     |  Methods defined here:
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  ----------------------------------------------------------------------
     |  Static methods defined here:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  columns
     |      width of the terminal window in characters
     |  
     |  lines
     |      height of the terminal window in characters
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |  
     |  n_fields = 2
     |  
     |  n_sequence_fields = 2
     |  
     |  n_unnamed_fields = 0
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.tuple:
     |  
     |  __add__(self, value, /)
     |      Return self+value.
     |  
     |  __contains__(self, key, /)
     |      Return key in self.
     |  
     |  __eq__(self, value, /)
     |      Return self==value.
     |  
     |  __ge__(self, value, /)
     |      Return self>=value.
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __getitem__(self, key, /)
     |      Return self[key].
     |  
     |  __getnewargs__(self, /)
     |  
     |  __gt__(self, value, /)
     |      Return self>value.
     |  
     |  __hash__(self, /)
     |      Return hash(self).
     |  
     |  __iter__(self, /)
     |      Implement iter(self).
     |  
     |  __le__(self, value, /)
     |      Return self<=value.
     |  
     |  __len__(self, /)
     |      Return len(self).
     |  
     |  __lt__(self, value, /)
     |      Return self<value.
     |  
     |  __mul__(self, value, /)
     |      Return self*value.
     |  
     |  __ne__(self, value, /)
     |      Return self!=value.
     |  
     |  __rmul__(self, value, /)
     |      Return value*self.
     |  
     |  count(self, value, /)
     |      Return number of occurrences of value.
     |  
     |  index(self, value, start=0, stop=9223372036854775807, /)
     |      Return first index of value.
     |      
     |      Raises ValueError if the value is not present.
    
    class times_result(builtins.tuple)
     |  times_result(iterable=(), /)
     |  
     |  times_result: Result from os.times().
     |  
     |  This object may be accessed either as a tuple of
     |    (user, system, children_user, children_system, elapsed),
     |  or via the attributes user, system, children_user, children_system,
     |  and elapsed.
     |  
     |  See os.times for more information.
     |  
     |  Method resolution order:
     |      times_result
     |      builtins.tuple
     |      builtins.object
     |  
     |  Methods defined here:
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  ----------------------------------------------------------------------
     |  Static methods defined here:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  children_system
     |      system time of children
     |  
     |  children_user
     |      user time of children
     |  
     |  elapsed
     |      elapsed time since an arbitrary point in the past
     |  
     |  system
     |      system time
     |  
     |  user
     |      user time
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |  
     |  n_fields = 5
     |  
     |  n_sequence_fields = 5
     |  
     |  n_unnamed_fields = 0
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.tuple:
     |  
     |  __add__(self, value, /)
     |      Return self+value.
     |  
     |  __contains__(self, key, /)
     |      Return key in self.
     |  
     |  __eq__(self, value, /)
     |      Return self==value.
     |  
     |  __ge__(self, value, /)
     |      Return self>=value.
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __getitem__(self, key, /)
     |      Return self[key].
     |  
     |  __getnewargs__(self, /)
     |  
     |  __gt__(self, value, /)
     |      Return self>value.
     |  
     |  __hash__(self, /)
     |      Return hash(self).
     |  
     |  __iter__(self, /)
     |      Implement iter(self).
     |  
     |  __le__(self, value, /)
     |      Return self<=value.
     |  
     |  __len__(self, /)
     |      Return len(self).
     |  
     |  __lt__(self, value, /)
     |      Return self<value.
     |  
     |  __mul__(self, value, /)
     |      Return self*value.
     |  
     |  __ne__(self, value, /)
     |      Return self!=value.
     |  
     |  __rmul__(self, value, /)
     |      Return value*self.
     |  
     |  count(self, value, /)
     |      Return number of occurrences of value.
     |  
     |  index(self, value, start=0, stop=9223372036854775807, /)
     |      Return first index of value.
     |      
     |      Raises ValueError if the value is not present.
    
    class uname_result(builtins.tuple)
     |  uname_result(iterable=(), /)
     |  
     |  uname_result: Result from os.uname().
     |  
     |  This object may be accessed either as a tuple of
     |    (sysname, nodename, release, version, machine),
     |  or via the attributes sysname, nodename, release, version, and machine.
     |  
     |  See os.uname for more information.
     |  
     |  Method resolution order:
     |      uname_result
     |      builtins.tuple
     |      builtins.object
     |  
     |  Methods defined here:
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  ----------------------------------------------------------------------
     |  Static methods defined here:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  machine
     |      hardware identifier
     |  
     |  nodename
     |      name of machine on network (implementation-defined)
     |  
     |  release
     |      operating system release
     |  
     |  sysname
     |      operating system name
     |  
     |  version
     |      operating system version
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |  
     |  n_fields = 5
     |  
     |  n_sequence_fields = 5
     |  
     |  n_unnamed_fields = 0
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.tuple:
     |  
     |  __add__(self, value, /)
     |      Return self+value.
     |  
     |  __contains__(self, key, /)
     |      Return key in self.
     |  
     |  __eq__(self, value, /)
     |      Return self==value.
     |  
     |  __ge__(self, value, /)
     |      Return self>=value.
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __getitem__(self, key, /)
     |      Return self[key].
     |  
     |  __getnewargs__(self, /)
     |  
     |  __gt__(self, value, /)
     |      Return self>value.
     |  
     |  __hash__(self, /)
     |      Return hash(self).
     |  
     |  __iter__(self, /)
     |      Implement iter(self).
     |  
     |  __le__(self, value, /)
     |      Return self<=value.
     |  
     |  __len__(self, /)
     |      Return len(self).
     |  
     |  __lt__(self, value, /)
     |      Return self<value.
     |  
     |  __mul__(self, value, /)
     |      Return self*value.
     |  
     |  __ne__(self, value, /)
     |      Return self!=value.
     |  
     |  __rmul__(self, value, /)
     |      Return value*self.
     |  
     |  count(self, value, /)
     |      Return number of occurrences of value.
     |  
     |  index(self, value, start=0, stop=9223372036854775807, /)
     |      Return first index of value.
     |      
     |      Raises ValueError if the value is not present.

FUNCTIONS
    WCOREDUMP(status, /)
        Return True if the process returning status was dumped to a core file.
    
    WEXITSTATUS(status)
        Return the process return code from status.
    
    WIFCONTINUED(status)
        Return True if a particular process was continued from a job control stop.
        
        Return True if the process returning status was continued from a
        job control stop.
    
    WIFEXITED(status)
        Return True if the process returning status exited via the exit() system call.
    
    WIFSIGNALED(status)
        Return True if the process returning status was terminated by a signal.
    
    WIFSTOPPED(status)
        Return True if the process returning status was stopped.
    
    WSTOPSIG(status)
        Return the signal that stopped the process that provided the status value.
    
    WTERMSIG(status)
        Return the signal that terminated the process that provided the status value.
    
    _exit(status)
        Exit to the system with specified status, without normal exit processing.
    
    abort()
        Abort the interpreter immediately.
        
        This function 'dumps core' or otherwise fails in the hardest way possible
        on the hosting operating system.  This function never returns.
    
    access(path, mode, *, dir_fd=None, effective_ids=False, follow_symlinks=True)
        Use the real uid/gid to test for access to a path.
        
          path
            Path to be tested; can be string, bytes, or a path-like object.
          mode
            Operating-system mode bitfield.  Can be F_OK to test existence,
            or the inclusive-OR of R_OK, W_OK, and X_OK.
          dir_fd
            If not None, it should be a file descriptor open to a directory,
            and path should be relative; path will then be relative to that
            directory.
          effective_ids
            If True, access will use the effective uid/gid instead of
            the real uid/gid.
          follow_symlinks
            If False, and the last element of the path is a symbolic link,
            access will examine the symbolic link itself instead of the file
            the link points to.
        
        dir_fd, effective_ids, and follow_symlinks may not be implemented
          on your platform.  If they are unavailable, using them will raise a
          NotImplementedError.
        
        Note that most operations will use the effective uid/gid, therefore this
          routine can be used in a suid/sgid environment to test if the invoking user
          has the specified access to the path.
    
    chdir(path)
        Change the current working directory to the specified path.
        
        path may always be specified as a string.
        On some platforms, path may also be specified as an open file descriptor.
          If this functionality is unavailable, using it raises an exception.
    
    chflags(path, flags, follow_symlinks=True)
        Set file flags.
        
        If follow_symlinks is False, and the last element of the path is a symbolic
          link, chflags will change flags on the symbolic link itself instead of the
          file the link points to.
        follow_symlinks may not be implemented on your platform.  If it is
        unavailable, using it will raise a NotImplementedError.
    
    chmod(path, mode, *, dir_fd=None, follow_symlinks=True)
        Change the access permissions of a file.
        
          path
            Path to be modified.  May always be specified as a str, bytes, or a path-like object.
            On some platforms, path may also be specified as an open file descriptor.
            If this functionality is unavailable, using it raises an exception.
          mode
            Operating-system mode bitfield.
          dir_fd
            If not None, it should be a file descriptor open to a directory,
            and path should be relative; path will then be relative to that
            directory.
          follow_symlinks
            If False, and the last element of the path is a symbolic link,
            chmod will modify the symbolic link itself instead of the file
            the link points to.
        
        It is an error to use dir_fd or follow_symlinks when specifying path as
          an open file descriptor.
        dir_fd and follow_symlinks may not be implemented on your platform.
          If they are unavailable, using them will raise a NotImplementedError.
    
    chown(path, uid, gid, *, dir_fd=None, follow_symlinks=True)
        Change the owner and group id of path to the numeric uid and gid.\
        
          path
            Path to be examined; can be string, bytes, a path-like object, or open-file-descriptor int.
          dir_fd
            If not None, it should be a file descriptor open to a directory,
            and path should be relative; path will then be relative to that
            directory.
          follow_symlinks
            If False, and the last element of the path is a symbolic link,
            stat will examine the symbolic link itself instead of the file
            the link points to.
        
        path may always be specified as a string.
        On some platforms, path may also be specified as an open file descriptor.
          If this functionality is unavailable, using it raises an exception.
        If dir_fd is not None, it should be a file descriptor open to a directory,
          and path should be relative; path will then be relative to that directory.
        If follow_symlinks is False, and the last element of the path is a symbolic
          link, chown will modify the symbolic link itself instead of the file the
          link points to.
        It is an error to use dir_fd or follow_symlinks when specifying path as
          an open file descriptor.
        dir_fd and follow_symlinks may not be implemented on your platform.
          If they are unavailable, using them will raise a NotImplementedError.
    
    chroot(path)
        Change root directory to path.
    
    close(fd)
        Close a file descriptor.
    
    closerange(fd_low, fd_high, /)
        Closes all file descriptors in [fd_low, fd_high), ignoring errors.
    
    confstr(name, /)
        Return a string-valued system configuration variable.
    
    cpu_count()
        Return the number of CPUs in the system; return None if indeterminable.
        
        This number is not equivalent to the number of CPUs the current process can
        use.  The number of usable CPUs can be obtained with
        ``len(os.sched_getaffinity(0))``
    
    ctermid()
        Return the name of the controlling terminal for this process.
    
    device_encoding(fd)
        Return a string describing the encoding of a terminal's file descriptor.
        
        The file descriptor must be attached to a terminal.
        If the device is not a terminal, return None.
    
    dup(fd, /)
        Return a duplicate of a file descriptor.
    
    dup2(fd, fd2, inheritable=True)
        Duplicate file descriptor.
    
    execl(file, *args)
        execl(file, *args)
        
        Execute the executable file with argument list args, replacing the
        current process.
    
    execle(file, *args)
        execle(file, *args, env)
        
        Execute the executable file with argument list args and
        environment env, replacing the current process.
    
    execlp(file, *args)
        execlp(file, *args)
        
        Execute the executable file (which is searched for along $PATH)
        with argument list args, replacing the current process.
    
    execlpe(file, *args)
        execlpe(file, *args, env)
        
        Execute the executable file (which is searched for along $PATH)
        with argument list args and environment env, replacing the current
        process.
    
    execv(path, argv, /)
        Execute an executable path with arguments, replacing current process.
        
        path
          Path of executable file.
        argv
          Tuple or list of strings.
    
    execve(path, argv, env)
        Execute an executable path with arguments, replacing current process.
        
        path
          Path of executable file.
        argv
          Tuple or list of strings.
        env
          Dictionary of strings mapping to strings.
    
    execvp(file, args)
        execvp(file, args)
        
        Execute the executable file (which is searched for along $PATH)
        with argument list args, replacing the current process.
        args may be a list or tuple of strings.
    
    execvpe(file, args, env)
        execvpe(file, args, env)
        
        Execute the executable file (which is searched for along $PATH)
        with argument list args and environment env , replacing the
        current process.
        args may be a list or tuple of strings.
    
    fchdir(fd)
        Change to the directory of the given file descriptor.
        
        fd must be opened on a directory, not a file.
        Equivalent to os.chdir(fd).
    
    fchmod(fd, mode)
        Change the access permissions of the file given by file descriptor fd.
        
        Equivalent to os.chmod(fd, mode).
    
    fchown(fd, uid, gid)
        Change the owner and group id of the file specified by file descriptor.
        
        Equivalent to os.chown(fd, uid, gid).
    
    fdopen(fd, *args, **kwargs)
        # Supply os.fdopen()
    
    fork()
        Fork a child process.
        
        Return 0 to child process and PID of child to parent process.
    
    forkpty()
        Fork a new process with a new pseudo-terminal as controlling tty.
        
        Returns a tuple of (pid, master_fd).
        Like fork(), return pid of 0 to the child process,
        and pid of child to the parent process.
        To both, return fd of newly opened pseudo-terminal.
    
    fpathconf(fd, name, /)
        Return the configuration limit name for the file descriptor fd.
        
        If there is no limit, return -1.
    
    fsdecode(filename)
        Decode filename (an os.PathLike, bytes, or str) from the filesystem
        encoding with 'surrogateescape' error handler, return str unchanged. On
        Windows, use 'strict' error handler if the file system encoding is
        'mbcs' (which is the default encoding).
    
    fsencode(filename)
        Encode filename (an os.PathLike, bytes, or str) to the filesystem
        encoding with 'surrogateescape' error handler, return bytes unchanged.
        On Windows, use 'strict' error handler if the file system encoding is
        'mbcs' (which is the default encoding).
    
    fspath(path)
        Return the file system path representation of the object.
        
        If the object is str or bytes, then allow it to pass through as-is. If the
        object defines __fspath__(), then return the result of that method. All other
        types raise a TypeError.
    
    fstat(fd)
        Perform a stat system call on the given file descriptor.
        
        Like stat(), but for an open file descriptor.
        Equivalent to os.stat(fd).
    
    fstatvfs(fd, /)
        Perform an fstatvfs system call on the given fd.
        
        Equivalent to statvfs(fd).
    
    fsync(fd)
        Force write of fd to disk.
    
    ftruncate(fd, length, /)
        Truncate a file, specified by file descriptor, to a specific length.
    
    fwalk(top='.', topdown=True, onerror=None, *, follow_symlinks=False, dir_fd=None)
        Directory tree generator.
        
        This behaves exactly like walk(), except that it yields a 4-tuple
        
            dirpath, dirnames, filenames, dirfd
        
        `dirpath`, `dirnames` and `filenames` are identical to walk() output,
        and `dirfd` is a file descriptor referring to the directory `dirpath`.
        
        The advantage of fwalk() over walk() is that it's safe against symlink
        races (when follow_symlinks is False).
        
        If dir_fd is not None, it should be a file descriptor open to a directory,
          and top should be relative; top will then be relative to that directory.
          (dir_fd is always supported for fwalk.)
        
        Caution:
        Since fwalk() yields file descriptors, those are only valid until the
        next iteration step, so you should dup() them if you want to keep them
        for a longer period.
        
        Example:
        
        import os
        for root, dirs, files, rootfd in os.fwalk('python/Lib/email'):
            print(root, "consumes", end="")
            print(sum([os.stat(name, dir_fd=rootfd).st_size for name in files]),
                  end="")
            print("bytes in", len(files), "non-directory files")
            if 'CVS' in dirs:
                dirs.remove('CVS')  # don't visit CVS directories
    
    get_blocking(...)
        get_blocking(fd) -> bool
        
        Get the blocking mode of the file descriptor:
        False if the O_NONBLOCK flag is set, True if the flag is cleared.
    
    get_exec_path(env=None)
        Returns the sequence of directories that will be searched for the
        named executable (similar to a shell) when launching a process.
        
        *env* must be an environment variable dict or None.  If *env* is None,
        os.environ will be used.
    
    get_inheritable(fd, /)
        Get the close-on-exe flag of the specified file descriptor.
    
    get_terminal_size(...)
        Return the size of the terminal window as (columns, lines).
        
        The optional argument fd (default standard output) specifies
        which file descriptor should be queried.
        
        If the file descriptor is not connected to a terminal, an OSError
        is thrown.
        
        This function will only be defined if an implementation is
        available for this system.
        
        shutil.get_terminal_size is the high-level function which should 
        normally be used, os.get_terminal_size is the low-level implementation.
    
    getcwd()
        Return a unicode string representing the current working directory.
    
    getcwdb()
        Return a bytes string representing the current working directory.
    
    getegid()
        Return the current process's effective group id.
    
    getenv(key, default=None)
        Get an environment variable, return None if it doesn't exist.
        The optional second argument can specify an alternate default.
        key, default and the result are str.
    
    getenvb(key, default=None)
        Get an environment variable, return None if it doesn't exist.
        The optional second argument can specify an alternate default.
        key, default and the result are bytes.
    
    geteuid()
        Return the current process's effective user id.
    
    getgid()
        Return the current process's group id.
    
    getgrouplist(...)
        getgrouplist(user, group) -> list of groups to which a user belongs
        
        Returns a list of groups to which a user belongs.
        
            user: username to lookup
            group: base group id of the user
    
    getgroups()
        Return list of supplemental group IDs for the process.
    
    getloadavg()
        Return average recent system load information.
        
        Return the number of processes in the system run queue averaged over
        the last 1, 5, and 15 minutes as a tuple of three floats.
        Raises OSError if the load average was unobtainable.
    
    getlogin()
        Return the actual login name.
    
    getpgid(pid)
        Call the system call getpgid(), and return the result.
    
    getpgrp()
        Return the current process group id.
    
    getpid()
        Return the current process id.
    
    getppid()
        Return the parent's process id.
        
        If the parent process has already exited, Windows machines will still
        return its id; others systems will return the id of the 'init' process (1).
    
    getpriority(which, who)
        Return program scheduling priority.
    
    getsid(pid, /)
        Call the system call getsid(pid) and return the result.
    
    getuid()
        Return the current process's user id.
    
    initgroups(...)
        initgroups(username, gid) -> None
        
        Call the system initgroups() to initialize the group access list with all of
        the groups of which the specified username is a member, plus the specified
        group id.
    
    isatty(fd, /)
        Return True if the fd is connected to a terminal.
        
        Return True if the file descriptor is an open file descriptor
        connected to the slave end of a terminal.
    
    kill(pid, signal, /)
        Kill a process with a signal.
    
    killpg(pgid, signal, /)
        Kill a process group with a signal.
    
    lchflags(path, flags)
        Set file flags.
        
        This function will not follow symbolic links.
        Equivalent to chflags(path, flags, follow_symlinks=False).
    
    lchmod(path, mode)
        Change the access permissions of a file, without following symbolic links.
        
        If path is a symlink, this affects the link itself rather than the target.
        Equivalent to chmod(path, mode, follow_symlinks=False)."
    
    lchown(path, uid, gid)
        Change the owner and group id of path to the numeric uid and gid.
        
        This function will not follow symbolic links.
        Equivalent to os.chown(path, uid, gid, follow_symlinks=False).
    
    link(src, dst, *, src_dir_fd=None, dst_dir_fd=None, follow_symlinks=True)
        Create a hard link to a file.
        
        If either src_dir_fd or dst_dir_fd is not None, it should be a file
          descriptor open to a directory, and the respective path string (src or dst)
          should be relative; the path will then be relative to that directory.
        If follow_symlinks is False, and the last element of src is a symbolic
          link, link will create a link to the symbolic link itself instead of the
          file the link points to.
        src_dir_fd, dst_dir_fd, and follow_symlinks may not be implemented on your
          platform.  If they are unavailable, using them will raise a
          NotImplementedError.
    
    listdir(path=None)
        Return a list containing the names of the files in the directory.
        
        path can be specified as either str, bytes, or a path-like object.  If path is bytes,
          the filenames returned will also be bytes; in all other circumstances
          the filenames returned will be str.
        If path is None, uses the path='.'.
        On some platforms, path may also be specified as an open file descriptor;\
          the file descriptor must refer to a directory.
          If this functionality is unavailable, using it raises NotImplementedError.
        
        The list is in arbitrary order.  It does not include the special
        entries '.' and '..' even if they are present in the directory.
    
    lockf(fd, command, length, /)
        Apply, test or remove a POSIX lock on an open file descriptor.
        
        fd
          An open file descriptor.
        command
          One of F_LOCK, F_TLOCK, F_ULOCK or F_TEST.
        length
          The number of bytes to lock, starting at the current position.
    
    lseek(fd, position, how, /)
        Set the position of a file descriptor.  Return the new position.
        
        Return the new cursor position in number of bytes
        relative to the beginning of the file.
    
    lstat(path, *, dir_fd=None)
        Perform a stat system call on the given path, without following symbolic links.
        
        Like stat(), but do not follow symbolic links.
        Equivalent to stat(path, follow_symlinks=False).
    
    major(device, /)
        Extracts a device major number from a raw device number.
    
    makedev(major, minor, /)
        Composes a raw device number from the major and minor device numbers.
    
    makedirs(name, mode=511, exist_ok=False)
        makedirs(name [, mode=0o777][, exist_ok=False])
        
        Super-mkdir; create a leaf directory and all intermediate ones.  Works like
        mkdir, except that any intermediate path segment (not just the rightmost)
        will be created if it does not exist. If the target directory already
        exists, raise an OSError if exist_ok is False. Otherwise no exception is
        raised.  This is recursive.
    
    minor(device, /)
        Extracts a device minor number from a raw device number.
    
    mkdir(path, mode=511, *, dir_fd=None)
        Create a directory.
        
        If dir_fd is not None, it should be a file descriptor open to a directory,
          and path should be relative; path will then be relative to that directory.
        dir_fd may not be implemented on your platform.
          If it is unavailable, using it will raise a NotImplementedError.
        
        The mode argument is ignored on Windows.
    
    mkfifo(path, mode=438, *, dir_fd=None)
        Create a "fifo" (a POSIX named pipe).
        
        If dir_fd is not None, it should be a file descriptor open to a directory,
          and path should be relative; path will then be relative to that directory.
        dir_fd may not be implemented on your platform.
          If it is unavailable, using it will raise a NotImplementedError.
    
    mknod(path, mode=384, device=0, *, dir_fd=None)
        Create a node in the file system.
        
        Create a node in the file system (file, device special file or named pipe)
        at path.  mode specifies both the permissions to use and the
        type of node to be created, being combined (bitwise OR) with one of
        S_IFREG, S_IFCHR, S_IFBLK, and S_IFIFO.  If S_IFCHR or S_IFBLK is set on mode,
        device defines the newly created device special file (probably using
        os.makedev()).  Otherwise device is ignored.
        
        If dir_fd is not None, it should be a file descriptor open to a directory,
          and path should be relative; path will then be relative to that directory.
        dir_fd may not be implemented on your platform.
          If it is unavailable, using it will raise a NotImplementedError.
    
    nice(increment, /)
        Add increment to the priority of process and return the new priority.
    
    open(path, flags, mode=511, *, dir_fd=None)
        Open a file for low level IO.  Returns a file descriptor (integer).
        
        If dir_fd is not None, it should be a file descriptor open to a directory,
          and path should be relative; path will then be relative to that directory.
        dir_fd may not be implemented on your platform.
          If it is unavailable, using it will raise a NotImplementedError.
    
    openpty()
        Open a pseudo-terminal.
        
        Return a tuple of (master_fd, slave_fd) containing open file descriptors
        for both the master and slave ends.
    
    pathconf(path, name)
        Return the configuration limit name for the file or directory path.
        
        If there is no limit, return -1.
        On some platforms, path may also be specified as an open file descriptor.
          If this functionality is unavailable, using it raises an exception.
    
    pipe()
        Create a pipe.
        
        Returns a tuple of two file descriptors:
          (read_fd, write_fd)
    
    popen(cmd, mode='r', buffering=-1)
        # Supply os.popen()
    
    pread(fd, length, offset, /)
        Read a number of bytes from a file descriptor starting at a particular offset.
        
        Read length bytes from file descriptor fd, starting at offset bytes from
        the beginning of the file.  The file offset remains unchanged.
    
    putenv(name, value, /)
        Change or add an environment variable.
    
    pwrite(fd, buffer, offset, /)
        Write bytes to a file descriptor starting at a particular offset.
        
        Write buffer to fd, starting at offset bytes from the beginning of
        the file.  Returns the number of bytes writte.  Does not change the
        current file offset.
    
    read(fd, length, /)
        Read from a file descriptor.  Returns a bytes object.
    
    readlink(...)
        readlink(path, *, dir_fd=None) -> path
        
        Return a string representing the path to which the symbolic link points.
        
        If dir_fd is not None, it should be a file descriptor open to a directory,
          and path should be relative; path will then be relative to that directory.
        dir_fd may not be implemented on your platform.
          If it is unavailable, using it will raise a NotImplementedError.
    
    readv(fd, buffers, /)
        Read from a file descriptor fd into an iterable of buffers.
        
        The buffers should be mutable buffers accepting bytes.
        readv will transfer data into each buffer until it is full
        and then move on to the next buffer in the sequence to hold
        the rest of the data.
        
        readv returns the total number of bytes read,
        which may be less than the total capacity of all the buffers.
    
    register_at_fork(*, before=None, after_in_child=None, after_in_parent=None)
        Register callables to be called when forking a new process.
        
          before
            A callable to be called in the parent before the fork() syscall.
          after_in_child
            A callable to be called in the child after fork().
          after_in_parent
            A callable to be called in the parent after fork().
        
        'before' callbacks are called in reverse order.
        'after_in_child' and 'after_in_parent' callbacks are called in order.
    
    remove(path, *, dir_fd=None)
        Remove a file (same as unlink()).
        
        If dir_fd is not None, it should be a file descriptor open to a directory,
          and path should be relative; path will then be relative to that directory.
        dir_fd may not be implemented on your platform.
          If it is unavailable, using it will raise a NotImplementedError.
    
    removedirs(name)
        removedirs(name)
        
        Super-rmdir; remove a leaf directory and all empty intermediate
        ones.  Works like rmdir except that, if the leaf directory is
        successfully removed, directories corresponding to rightmost path
        segments will be pruned away until either the whole path is
        consumed or an error occurs.  Errors during this latter phase are
        ignored -- they generally mean that a directory was not empty.
    
    rename(src, dst, *, src_dir_fd=None, dst_dir_fd=None)
        Rename a file or directory.
        
        If either src_dir_fd or dst_dir_fd is not None, it should be a file
          descriptor open to a directory, and the respective path string (src or dst)
          should be relative; the path will then be relative to that directory.
        src_dir_fd and dst_dir_fd, may not be implemented on your platform.
          If they are unavailable, using them will raise a NotImplementedError.
    
    renames(old, new)
        renames(old, new)
        
        Super-rename; create directories as necessary and delete any left
        empty.  Works like rename, except creation of any intermediate
        directories needed to make the new pathname good is attempted
        first.  After the rename, directories corresponding to rightmost
        path segments of the old name will be pruned until either the
        whole path is consumed or a nonempty directory is found.
        
        Note: this function can fail with the new directory structure made
        if you lack permissions needed to unlink the leaf directory or
        file.
    
    replace(src, dst, *, src_dir_fd=None, dst_dir_fd=None)
        Rename a file or directory, overwriting the destination.
        
        If either src_dir_fd or dst_dir_fd is not None, it should be a file
          descriptor open to a directory, and the respective path string (src or dst)
          should be relative; the path will then be relative to that directory.
        src_dir_fd and dst_dir_fd, may not be implemented on your platform.
          If they are unavailable, using them will raise a NotImplementedError.
    
    rmdir(path, *, dir_fd=None)
        Remove a directory.
        
        If dir_fd is not None, it should be a file descriptor open to a directory,
          and path should be relative; path will then be relative to that directory.
        dir_fd may not be implemented on your platform.
          If it is unavailable, using it will raise a NotImplementedError.
    
    scandir(path=None)
        Return an iterator of DirEntry objects for given path.
        
        path can be specified as either str, bytes, or a path-like object.  If path
        is bytes, the names of yielded DirEntry objects will also be bytes; in
        all other circumstances they will be str.
        
        If path is None, uses the path='.'.
    
    sched_get_priority_max(policy)
        Get the maximum scheduling priority for policy.
    
    sched_get_priority_min(policy)
        Get the minimum scheduling priority for policy.
    
    sched_yield()
        Voluntarily relinquish the CPU.
    
    sendfile(...)
        sendfile(out, in, offset, count) -> byteswritten
        sendfile(out, in, offset, count[, headers][, trailers], flags=0)
                    -> byteswritten
        Copy count bytes from file descriptor in to file descriptor out.
    
    set_blocking(...)
        set_blocking(fd, blocking)
        
        Set the blocking mode of the specified file descriptor.
        Set the O_NONBLOCK flag if blocking is False,
        clear the O_NONBLOCK flag otherwise.
    
    set_inheritable(fd, inheritable, /)
        Set the inheritable flag of the specified file descriptor.
    
    setegid(egid, /)
        Set the current process's effective group id.
    
    seteuid(euid, /)
        Set the current process's effective user id.
    
    setgid(gid, /)
        Set the current process's group id.
    
    setgroups(groups, /)
        Set the groups of the current process to list.
    
    setpgid(pid, pgrp, /)
        Call the system call setpgid(pid, pgrp).
    
    setpgrp()
        Make the current process the leader of its process group.
    
    setpriority(which, who, priority)
        Set program scheduling priority.
    
    setregid(rgid, egid, /)
        Set the current process's real and effective group ids.
    
    setreuid(ruid, euid, /)
        Set the current process's real and effective user ids.
    
    setsid()
        Call the system call setsid().
    
    setuid(uid, /)
        Set the current process's user id.
    
    spawnl(mode, file, *args)
        spawnl(mode, file, *args) -> integer
        
        Execute file with arguments from args in a subprocess.
        If mode == P_NOWAIT return the pid of the process.
        If mode == P_WAIT return the process's exit code if it exits normally;
        otherwise return -SIG, where SIG is the signal that killed it.
    
    spawnle(mode, file, *args)
        spawnle(mode, file, *args, env) -> integer
        
        Execute file with arguments from args in a subprocess with the
        supplied environment.
        If mode == P_NOWAIT return the pid of the process.
        If mode == P_WAIT return the process's exit code if it exits normally;
        otherwise return -SIG, where SIG is the signal that killed it.
    
    spawnlp(mode, file, *args)
        spawnlp(mode, file, *args) -> integer
        
        Execute file (which is looked for along $PATH) with arguments from
        args in a subprocess with the supplied environment.
        If mode == P_NOWAIT return the pid of the process.
        If mode == P_WAIT return the process's exit code if it exits normally;
        otherwise return -SIG, where SIG is the signal that killed it.
    
    spawnlpe(mode, file, *args)
        spawnlpe(mode, file, *args, env) -> integer
        
        Execute file (which is looked for along $PATH) with arguments from
        args in a subprocess with the supplied environment.
        If mode == P_NOWAIT return the pid of the process.
        If mode == P_WAIT return the process's exit code if it exits normally;
        otherwise return -SIG, where SIG is the signal that killed it.
    
    spawnv(mode, file, args)
        spawnv(mode, file, args) -> integer
        
        Execute file with arguments from args in a subprocess.
        If mode == P_NOWAIT return the pid of the process.
        If mode == P_WAIT return the process's exit code if it exits normally;
        otherwise return -SIG, where SIG is the signal that killed it.
    
    spawnve(mode, file, args, env)
        spawnve(mode, file, args, env) -> integer
        
        Execute file with arguments from args in a subprocess with the
        specified environment.
        If mode == P_NOWAIT return the pid of the process.
        If mode == P_WAIT return the process's exit code if it exits normally;
        otherwise return -SIG, where SIG is the signal that killed it.
    
    spawnvp(mode, file, args)
        spawnvp(mode, file, args) -> integer
        
        Execute file (which is looked for along $PATH) with arguments from
        args in a subprocess.
        If mode == P_NOWAIT return the pid of the process.
        If mode == P_WAIT return the process's exit code if it exits normally;
        otherwise return -SIG, where SIG is the signal that killed it.
    
    spawnvpe(mode, file, args, env)
        spawnvpe(mode, file, args, env) -> integer
        
        Execute file (which is looked for along $PATH) with arguments from
        args in a subprocess with the supplied environment.
        If mode == P_NOWAIT return the pid of the process.
        If mode == P_WAIT return the process's exit code if it exits normally;
        otherwise return -SIG, where SIG is the signal that killed it.
    
    stat(path, *, dir_fd=None, follow_symlinks=True)
        Perform a stat system call on the given path.
        
          path
            Path to be examined; can be string, bytes, a path-like object or
            open-file-descriptor int.
          dir_fd
            If not None, it should be a file descriptor open to a directory,
            and path should be a relative string; path will then be relative to
            that directory.
          follow_symlinks
            If False, and the last element of the path is a symbolic link,
            stat will examine the symbolic link itself instead of the file
            the link points to.
        
        dir_fd and follow_symlinks may not be implemented
          on your platform.  If they are unavailable, using them will raise a
          NotImplementedError.
        
        It's an error to use dir_fd or follow_symlinks when specifying path as
          an open file descriptor.
    
    statvfs(path)
        Perform a statvfs system call on the given path.
        
        path may always be specified as a string.
        On some platforms, path may also be specified as an open file descriptor.
          If this functionality is unavailable, using it raises an exception.
    
    strerror(code, /)
        Translate an error code to a message string.
    
    symlink(src, dst, target_is_directory=False, *, dir_fd=None)
        Create a symbolic link pointing to src named dst.
        
        target_is_directory is required on Windows if the target is to be
          interpreted as a directory.  (On Windows, symlink requires
          Windows 6.0 or greater, and raises a NotImplementedError otherwise.)
          target_is_directory is ignored on non-Windows platforms.
        
        If dir_fd is not None, it should be a file descriptor open to a directory,
          and path should be relative; path will then be relative to that directory.
        dir_fd may not be implemented on your platform.
          If it is unavailable, using it will raise a NotImplementedError.
    
    sync()
        Force write of everything to disk.
    
    sysconf(name, /)
        Return an integer-valued system configuration variable.
    
    system(command)
        Execute the command in a subshell.
    
    tcgetpgrp(fd, /)
        Return the process group associated with the terminal specified by fd.
    
    tcsetpgrp(fd, pgid, /)
        Set the process group associated with the terminal specified by fd.
    
    times()
        Return a collection containing process timing information.
        
        The object returned behaves like a named tuple with these fields:
          (utime, stime, cutime, cstime, elapsed_time)
        All fields are floating point numbers.
    
    truncate(path, length)
        Truncate a file, specified by path, to a specific length.
        
        On some platforms, path may also be specified as an open file descriptor.
          If this functionality is unavailable, using it raises an exception.
    
    ttyname(fd, /)
        Return the name of the terminal device connected to 'fd'.
        
        fd
          Integer file descriptor handle.
    
    umask(mask, /)
        Set the current numeric umask and return the previous umask.
    
    uname()
        Return an object identifying the current operating system.
        
        The object behaves like a named tuple with the following fields:
          (sysname, nodename, release, version, machine)
    
    unlink(path, *, dir_fd=None)
        Remove a file (same as remove()).
        
        If dir_fd is not None, it should be a file descriptor open to a directory,
          and path should be relative; path will then be relative to that directory.
        dir_fd may not be implemented on your platform.
          If it is unavailable, using it will raise a NotImplementedError.
    
    unsetenv(name, /)
        Delete an environment variable.
    
    urandom(size, /)
        Return a bytes object containing random bytes suitable for cryptographic use.
    
    utime(path, times=None, *, ns=None, dir_fd=None, follow_symlinks=True)
        Set the access and modified time of path.
        
        path may always be specified as a string.
        On some platforms, path may also be specified as an open file descriptor.
          If this functionality is unavailable, using it raises an exception.
        
        If times is not None, it must be a tuple (atime, mtime);
            atime and mtime should be expressed as float seconds since the epoch.
        If ns is specified, it must be a tuple (atime_ns, mtime_ns);
            atime_ns and mtime_ns should be expressed as integer nanoseconds
            since the epoch.
        If times is None and ns is unspecified, utime uses the current time.
        Specifying tuples for both times and ns is an error.
        
        If dir_fd is not None, it should be a file descriptor open to a directory,
          and path should be relative; path will then be relative to that directory.
        If follow_symlinks is False, and the last element of the path is a symbolic
          link, utime will modify the symbolic link itself instead of the file the
          link points to.
        It is an error to use dir_fd or follow_symlinks when specifying path
          as an open file descriptor.
        dir_fd and follow_symlinks may not be available on your platform.
          If they are unavailable, using them will raise a NotImplementedError.
    
    wait()
        Wait for completion of a child process.
        
        Returns a tuple of information about the child process:
            (pid, status)
    
    wait3(options)
        Wait for completion of a child process.
        
        Returns a tuple of information about the child process:
          (pid, status, rusage)
    
    wait4(pid, options)
        Wait for completion of a specific child process.
        
        Returns a tuple of information about the child process:
          (pid, status, rusage)
    
    waitpid(pid, options, /)
        Wait for completion of a given child process.
        
        Returns a tuple of information regarding the child process:
            (pid, status)
        
        The options argument is ignored on Windows.
    
    walk(top, topdown=True, onerror=None, followlinks=False)
    
    sched_get_priority_min(policy)
        Get the minimum scheduling priority for policy.
    
    sched_yield()
        Voluntarily relinquish the CPU.
    
    sendfile(...)
        sendfile(out, in, offset, count) -> byteswritten
        sendfile(out, in, offset, count[, headers][, trailers], flags=0)
                    -> byteswritten
        Copy count bytes from file descriptor in to file descriptor out.
    
    set_blocking(...)
        set_blocking(fd, blocking)
        
        Set the blocking mode of the specified file descriptor.
        Set the O_NONBLOCK flag if blocking is False,
        clear the O_NONBLOCK flag otherwise.
    
    set_inheritable(fd, inheritable, /)
        Set the inheritable flag of the specified file descriptor.
    
    setegid(egid, /)
        Set the current process's effective group id.
    
    seteuid(euid, /)
        Set the current process's effective user id.
    
    setgid(gid, /)
        Set the current process's group id.
    
    setgroups(groups, /)
        Set the groups of the current process to list.
    
    setpgid(pid, pgrp, /)
        Call the system call setpgid(pid, pgrp).
    
    setpgrp()
        Make the current process the leader of its process group.
    
    setpriority(which, who, priority)
        Set program scheduling priority.
    
    setregid(rgid, egid, /)
        Set the current process's real and effective group ids.
    
    setreuid(ruid, euid, /)
        Set the current process's real and effective user ids.
    
    setsid()
        Call the system call setsid().
    
    setuid(uid, /)
        Set the current process's user id.
    
    spawnl(mode, file, *args)
        spawnl(mode, file, *args) -> integer
        
        Execute file with arguments from args in a subprocess.
        If mode == P_NOWAIT return the pid of the process.
        If mode == P_WAIT return the process's exit code if it exits normally;
        otherwise return -SIG, where SIG is the signal that killed it.
    
    spawnle(mode, file, *args)
        spawnle(mode, file, *args, env) -> integer
        
        Execute file with arguments from args in a subprocess with the
        supplied environment.
        If mode == P_NOWAIT return the pid of the process.
        If mode == P_WAIT return the process's exit code if it exits normally;
        otherwise return -SIG, where SIG is the signal that killed it.
    
    spawnlp(mode, file, *args)
        spawnlp(mode, file, *args) -> integer
        
        Execute file (which is looked for along $PATH) with arguments from
        args in a subprocess with the supplied environment.
        If mode == P_NOWAIT return the pid of the process.
        If mode == P_WAIT return the process's exit code if it exits normally;
        otherwise return -SIG, where SIG is the signal that killed it.
    
    spawnlpe(mode, file, *args)
        spawnlpe(mode, file, *args, env) -> integer
        
        Execute file (which is looked for along $PATH) with arguments from
        args in a subprocess with the supplied environment.
        If mode == P_NOWAIT return the pid of the process.
        If mode == P_WAIT return the process's exit code if it exits normally;
        otherwise return -SIG, where SIG is the signal that killed it.
    
    spawnv(mode, file, args)
        spawnv(mode, file, args) -> integer
        
        Execute file with arguments from args in a subprocess.
        If mode == P_NOWAIT return the pid of the process.
        If mode == P_WAIT return the process's exit code if it exits normally;
        otherwise return -SIG, where SIG is the signal that killed it.
    
    spawnve(mode, file, args, env)
        spawnve(mode, file, args, env) -> integer
        
        Execute file with arguments from args in a subprocess with the
        specified environment.
        If mode == P_NOWAIT return the pid of the process.
        If mode == P_WAIT return the process's exit code if it exits normally;
        otherwise return -SIG, where SIG is the signal that killed it.
    
    spawnvp(mode, file, args)
        spawnvp(mode, file, args) -> integer
        
        Execute file (which is looked for along $PATH) with arguments from
        args in a subprocess.
        If mode == P_NOWAIT return the pid of the process.
        If mode == P_WAIT return the process's exit code if it exits normally;
        otherwise return -SIG, where SIG is the signal that killed it.
    
    spawnvpe(mode, file, args, env)
        spawnvpe(mode, file, args, env) -> integer
        
        Execute file (which is looked for along $PATH) with arguments from
        args in a subprocess with the supplied environment.
        If mode == P_NOWAIT return the pid of the process.
        If mode == P_WAIT return the process's exit code if it exits normally;
        otherwise return -SIG, where SIG is the signal that killed it.
    
    stat(path, *, dir_fd=None, follow_symlinks=True)
        Perform a stat system call on the given path.
        
          path
            Path to be examined; can be string, bytes, a path-like object or
            open-file-descriptor int.
          dir_fd
            If not None, it should be a file descriptor open to a directory,
            and path should be a relative string; path will then be relative to
            that directory.
          follow_symlinks
            If False, and the last element of the path is a symbolic link,
            stat will examine the symbolic link itself instead of the file
            the link points to.
        
        dir_fd and follow_symlinks may not be implemented
          on your platform.  If they are unavailable, using them will raise a
          NotImplementedError.
        
        It's an error to use dir_fd or follow_symlinks when specifying path as
          an open file descriptor.
    
    statvfs(path)
        Perform a statvfs system call on the given path.
        
        path may always be specified as a string.
        On some platforms, path may also be specified as an open file descriptor.
          If this functionality is unavailable, using it raises an exception.
    
    strerror(code, /)
        Translate an error code to a message string.
    
    symlink(src, dst, target_is_directory=False, *, dir_fd=None)
        Create a symbolic link pointing to src named dst.
        
        target_is_directory is required on Windows if the target is to be
          interpreted as a directory.  (On Windows, symlink requires
          Windows 6.0 or greater, and raises a NotImplementedError otherwise.)
          target_is_directory is ignored on non-Windows platforms.
        
        If dir_fd is not None, it should be a file descriptor open to a directory,
          and path should be relative; path will then be relative to that directory.
        dir_fd may not be implemented on your platform.
          If it is unavailable, using it will raise a NotImplementedError.
    
    sync()
        Force write of everything to disk.
    
    sysconf(name, /)
        Return an integer-valued system configuration variable.
    
    system(command)
        Execute the command in a subshell.
    
    tcgetpgrp(fd, /)
        Return the process group associated with the terminal specified by fd.
    
    tcsetpgrp(fd, pgid, /)
        Set the process group associated with the terminal specified by fd.
    
    times()
        Return a collection containing process timing information.
        
        The object returned behaves like a named tuple with these fields:
          (utime, stime, cutime, cstime, elapsed_time)
        All fields are floating point numbers.
    
    truncate(path, length)
        Truncate a file, specified by path, to a specific length.
        
        On some platforms, path may also be specified as an open file descriptor.
          If this functionality is unavailable, using it raises an exception.
    
    ttyname(fd, /)
        Return the name of the terminal device connected to 'fd'.
        
        fd
          Integer file descriptor handle.
    
    umask(mask, /)
        Set the current numeric umask and return the previous umask.
    
    uname()
        Return an object identifying the current operating system.
        
        The object behaves like a named tuple with the following fields:
          (sysname, nodename, release, version, machine)
    
    unlink(path, *, dir_fd=None)
        Remove a file (same as remove()).
        
        If dir_fd is not None, it should be a file descriptor open to a directory,
          and path should be relative; path will then be relative to that directory.
        dir_fd may not be implemented on your platform.
          If it is unavailable, using it will raise a NotImplementedError.
    
    unsetenv(name, /)
        Delete an environment variable.
    
    urandom(size, /)
        Return a bytes object containing random bytes suitable for cryptographic use.
    
    utime(path, times=None, *, ns=None, dir_fd=None, follow_symlinks=True)
        Set the access and modified time of path.
        
        path may always be specified as a string.
        On some platforms, path may also be specified as an open file descriptor.
          If this functionality is unavailable, using it raises an exception.
        
        If times is not None, it must be a tuple (atime, mtime);
            atime and mtime should be expressed as float seconds since the epoch.
        If ns is specified, it must be a tuple (atime_ns, mtime_ns);
            atime_ns and mtime_ns should be expressed as integer nanoseconds
            since the epoch.
        If times is None and ns is unspecified, utime uses the current time.
        Specifying tuples for both times and ns is an error.
        
        If dir_fd is not None, it should be a file descriptor open to a directory,
          and path should be relative; path will then be relative to that directory.
        If follow_symlinks is False, and the last element of the path is a symbolic
          link, utime will modify the symbolic link itself instead of the file the
          link points to.
        It is an error to use dir_fd or follow_symlinks when specifying path
          as an open file descriptor.
        dir_fd and follow_symlinks may not be available on your platform.
          If they are unavailable, using them will raise a NotImplementedError.
    
    wait()
        Wait for completion of a child process.
        
        Returns a tuple of information about the child process:
            (pid, status)
    
    wait3(options)
        Wait for completion of a child process.
        
        Returns a tuple of information about the child process:
          (pid, status, rusage)
    
    wait4(pid, options)
        Wait for completion of a specific child process.
        
        Returns a tuple of information about the child process:
          (pid, status, rusage)
    
    waitpid(pid, options, /)
        Wait for completion of a given child process.
        
        Returns a tuple of information regarding the child process:
            (pid, status)
        
        The options argument is ignored on Windows.
    
    walk(top, topdown=True, onerror=None, followlinks=False)
        Directory tree generator.
        
        For each directory in the directory tree rooted at top (including top
        itself, but excluding '.' and '..'), yields a 3-tuple
        
            dirpath, dirnames, filenames
        
        dirpath is a string, the path to the directory.  dirnames is a list of
        the names of the subdirectories in dirpath (excluding '.' and '..').
        filenames is a list of the names of the non-directory files in dirpath.
        Note that the names in the lists are just names, with no path components.
        To get a full path (which begins with top) to a file or directory in
        dirpath, do os.path.join(dirpath, name).
        
        If optional arg 'topdown' is true or not specified, the triple for a
        directory is generated before the triples for any of its subdirectories
        (directories are generated top down).  If topdown is false, the triple
        for a directory is generated after the triples for all of its
        subdirectories (directories are generated bottom up).
        
        When topdown is true, the caller can modify the dirnames list in-place
        (e.g., via del or slice assignment), and walk will only recurse into the
        subdirectories whose names remain in dirnames; this can be used to prune the
        search, or to impose a specific order of visiting.  Modifying dirnames when
        topdown is false is ineffective, since the directories in dirnames have
        already been generated by the time dirnames itself is generated. No matter
        the value of topdown, the list of subdirectories is retrieved before the
        tuples for the directory and its subdirectories are generated.
        
        By default errors from the os.scandir() call are ignored.  If
        optional arg 'onerror' is specified, it should be a function; it
        will be called with one argument, an OSError instance.  It can
        report the error to continue with the walk, or raise the exception
        to abort the walk.  Note that the filename is available as the
        filename attribute of the exception object.
        
        By default, os.walk does not follow symbolic links to subdirectories on
        systems that support them.  In order to get this functionality, set the
        optional argument 'followlinks' to true.
        
        Caution:  if you pass a relative pathname for top, don't change the
        current working directory between resumptions of walk.  walk never
        changes the current directory, and assumes that the client doesn't
        either.
        
        Example:
        
        import os
        from os.path import join, getsize
        for root, dirs, files in os.walk('python/Lib/email'):
            print(root, "consumes", end="")
            print(sum([getsize(join(root, name)) for name in files]), end="")
            print("bytes in", len(files), "non-directory files")
            if 'CVS' in dirs:
                dirs.remove('CVS')  # don't visit CVS directories
    
    write(fd, data, /)
        Write a bytes object to a file descriptor.
    
    writev(fd, buffers, /)
        Iterate over buffers, and write the contents of each to a file descriptor.
        
        Returns the total number of bytes written.
        buffers must be a sequence of bytes-like objects.

DATA

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
CLD_CONTINUED = 6
CLD_DUMPED = 3
CLD_EXITED = 1
CLD_TRAPPED = 4
EX_CANTCREAT = 73
EX_CONFIG = 78
EX_DATAERR = 65
EX_IOERR = 74
EX_NOHOST = 68
EX_NOINPUT = 66
EX_NOPERM = 77
EX_NOUSER = 67
EX_OK = 0
EX_OSERR = 71
EX_OSFILE = 72
EX_PROTOCOL = 76
EX_SOFTWARE = 70
EX_TEMPFAIL = 75
EX_UNAVAILABLE = 69
EX_USAGE = 64
F_LOCK = 1
F_OK = 0
F_TEST = 3
F_TLOCK = 2
F_ULOCK = 0
NGROUPS_MAX = 16
O_ACCMODE = 3
O_APPEND = 8
O_ASYNC = 64
O_CLOEXEC = 16777216
O_CREAT = 512
O_DIRECTORY = 1048576
O_DSYNC = 4194304
O_EXCL = 2048
O_EXLOCK = 32
O_NDELAY = 4
O_NOCTTY = 131072
O_NOFOLLOW = 256
O_NONBLOCK = 4
O_RDONLY = 0
O_RDWR = 2
O_SHLOCK = 16
O_SYNC = 128
O_TRUNC = 1024
O_WRONLY = 1
PRIO_PGRP = 1
PRIO_PROCESS = 0
PRIO_USER = 2
P_ALL = 0
P_NOWAIT = 1
P_NOWAITO = 1
P_PGID = 2
P_PID = 1
P_WAIT = 0
RTLD_GLOBAL = 8
RTLD_LAZY = 1
RTLD_LOCAL = 4
RTLD_NODELETE = 128
RTLD_NOLOAD = 16
RTLD_NOW = 2
R_OK = 4
SCHED_FIFO = 4
SCHED_OTHER = 1
SCHED_RR = 2
SEEK_CUR = 1
SEEK_END = 2
SEEK_SET = 0
ST_NOSUID = 2
ST_RDONLY = 1
TMP_MAX = 308915776
WCONTINUED = 16
WEXITED = 4
WNOHANG = 1
WNOWAIT = 32
WSTOPPED = 8
WUNTRACED = 2
W_OK = 2
X_OK = 1
__all__ = ['altsep', 'curdir', 'pardir', 'sep', 'pathsep', 'linesep', ...
altsep = None
confstr_names = {'CS_PATH': 1, 'CS_XBS5_ILP32_OFF32_CFLAGS': 20, 'CS_X...
curdir = '.'
defpath = ':/bin:/usr/bin'
devnull = '/dev/null'
environ = environ({'TERM_PROGRAM': 'Apple_Terminal', 'SHEL...e', '_': ...
environb = environ({b'TERM_PROGRAM': b'Apple_Terminal', b'S..., b'_': ...
extsep = '.'
linesep = '\n'
name = 'posix'
pardir = '..'
pathconf_names = {'PC_ALLOC_SIZE_MIN': 16, 'PC_ASYNC_IO': 17, 'PC_CHOW...
pathsep = ':'
sep = '/'
supports_bytes_environ = True
sysconf_names = {'SC_2_CHAR_TERM': 20, 'SC_2_C_BIND': 18, 'SC_2_C_DEV'...

MySQL Connector/Python

Help on package mysql.connector in mysql

NAME
1
# mysql.connector - MySQL Connector/Python - MySQL driver written in Python
PACKAGE CONTENTS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
abstracts
authentication
catch23
charsets
connection
connection_cext
constants
conversion
cursor
cursor_cext
custom_types
dbapi
django (package)
errorcode
errors
locales (package)
network
optionfiles
pooling
protocol
utils
version
CLASSES
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
builtins.Exception(builtins.BaseException)
- mysql.connector.errors.Error
    - mysql.connector.errors.DatabaseError
        - mysql.connector.errors.DataError
        - mysql.connector.errors.IntegrityError
        - mysql.connector.errors.InternalError
        - mysql.connector.errors.NotSupportedError
        - mysql.connector.errors.OperationalError
        - mysql.connector.errors.ProgrammingError
        - mysql.connector.errors.InterfaceError
- mysql.connector.errors.Warning

builtins.object
- builtins.bytes
- datetime.date
    - datetime.datetime
- datetime.time

mysql.connector.abstracts.MySQLConnectionAbstract(mysql.connector.abstracts.MySQLConnectionAbstract, builtins.object)
- mysql.connector.connection.MySQLConnection
- mysql.connector.connection_cext.CMySQLConnection

mysql.connector.constants._Constants(builtins.object)
- mysql.connector.constants.CharacterSet
- mysql.connector.constants.FieldType
- mysql.connector.constants.RefreshOption

mysql.connector.constants._Flags(mysql.connector.constants._Constants)
- mysql.connector.constants.ClientFlag
- mysql.connector.constants.FieldFlag
Binary
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
Binary = class bytes(object)
     |  bytes(iterable_of_ints) -> bytes
     |  bytes(string, encoding[, errors]) -> bytes
     |  bytes(bytes_or_buffer) -> immutable copy of bytes_or_buffer
     |  bytes(int) -> bytes object of size given by the parameter initialized with null bytes
     |  bytes() -> empty bytes object
     |  
     |  Construct an immutable array of bytes from:
     |    - an iterable yielding integers in range(256)
     |    - a text string encoded using the specified encoding
     |    - any object implementing the buffer API.
     |    - an integer
     |  
     |  Methods defined here:
     |  
     |  __add__(self, value, /)
     |      Return self+value.
     |  
     |  __contains__(self, key, /)
     |      Return key in self.
     |  
     |  __eq__(self, value, /)
     |      Return self==value.
     |  
     |  __ge__(self, value, /)
     |      Return self>=value.
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __getitem__(self, key, /)
     |      Return self[key].
     |  
     |  __getnewargs__(...)
     |  
     |  __gt__(self, value, /)
     |      Return self>value.
     |  
     |  __hash__(self, /)
     |      Return hash(self).
     |  
     |  __iter__(self, /)
     |      Implement iter(self).
     |  
     |  __le__(self, value, /)
     |      Return self<=value.
     |  
     |  __len__(self, /)
     |      Return len(self).
     |  
     |  __lt__(self, value, /)
     |      Return self<value.
     |  
     |  __mod__(self, value, /)
     |      Return self%value.
     |  
     |  __mul__(self, value, /)
     |      Return self*value.
     |  
     |  __ne__(self, value, /)
     |      Return self!=value.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  __rmod__(self, value, /)
     |      Return value%self.
     |  
     |  __rmul__(self, value, /)
     |      Return value*self.
     |  
     |  __str__(self, /)
     |      Return str(self).
     |  
     |  capitalize(...)
     |      B.capitalize() -> copy of B
     |      
     |      Return a copy of B with only its first character capitalized (ASCII)
     |      and the rest lower-cased.
     |  
     |  center(...)
     |      B.center(width[, fillchar]) -> copy of B
     |      
     |      Return B centered in a string of length width.  Padding is
     |      done using the specified fill character (default is a space).
     |  
     |  count(...)
     |      B.count(sub[, start[, end]]) -> int
     |      
     |      Return the number of non-overlapping occurrences of subsection sub in
     |      bytes B[start:end].  Optional arguments start and end are interpreted
     |      as in slice notation.
     |  
     |  decode(self, /, encoding='utf-8', errors='strict')
     |      Decode the bytes using the codec registered for encoding.
     |      
     |      encoding
     |        The encoding with which to decode the bytes.
     |      errors
     |        The error handling scheme to use for the handling of decoding errors.
     |        The default is 'strict' meaning that decoding errors raise a
     |        UnicodeDecodeError. Other possible values are 'ignore' and 'replace'
     |        as well as any other name registered with codecs.register_error that
     |        can handle UnicodeDecodeErrors.
     |  
     |  endswith(...)
     |      B.endswith(suffix[, start[, end]]) -> bool
     |      
     |      Return True if B ends with the specified suffix, False otherwise.
     |      With optional start, test B beginning at that position.
     |      With optional end, stop comparing B at that position.
     |      suffix can also be a tuple of bytes to try.
     |  
     |  expandtabs(...)
     |      B.expandtabs(tabsize=8) -> copy of B
     |      
     |      Return a copy of B where all tab characters are expanded using spaces.
     |      If tabsize is not given, a tab size of 8 characters is assumed.
     |  
     |  find(...)
     |      B.find(sub[, start[, end]]) -> int
     |      
     |      Return the lowest index in B where subsection sub is found,
     |      such that sub is contained within B[start,end].  Optional
     |      arguments start and end are interpreted as in slice notation.
     |      
     |      Return -1 on failure.
     |  
     |  hex(...)
     |      B.hex() -> string
     |      
     |      Create a string of hexadecimal numbers from a bytes object.
     |      Example: b'\xb9\x01\xef'.hex() -> 'b901ef'.
     |  
     |  index(...)
     |      B.index(sub[, start[, end]]) -> int
     |      
     |      Return the lowest index in B where subsection sub is found,
     |      such that sub is contained within B[start,end].  Optional
     |      arguments start and end are interpreted as in slice notation.
     |      
     |      Raises ValueError when the subsection is not found.
     |  
     |  isalnum(...)
     |      B.isalnum() -> bool
     |      
     |      Return True if all characters in B are alphanumeric
     |      and there is at least one character in B, False otherwise.
     |  
     |  isalpha(...)
     |      B.isalpha() -> bool
     |      
     |      Return True if all characters in B are alphabetic
     |      and there is at least one character in B, False otherwise.
     |  
     |  isascii(...)
     |      B.isascii() -> bool
     |      
     |      Return True if B is empty or all characters in B are ASCII,
     |      False otherwise.
     |  
     |  isdigit(...)
     |      B.isdigit() -> bool
     |      
     |      Return True if all characters in B are digits
     |      and there is at least one character in B, False otherwise.
     |  
     |  islower(...)
     |      B.islower() -> bool
     |      
     |      Return True if all cased characters in B are lowercase and there is
     |      at least one cased character in B, False otherwise.
     |  
     |  isspace(...)
     |      B.isspace() -> bool
     |      
     |      Return True if all characters in B are whitespace
     |      and there is at least one character in B, False otherwise.
     |  
     |  istitle(...)
     |      B.istitle() -> bool
     |      
     |      Return True if B is a titlecased string and there is at least one
     |      character in B, i.e. uppercase characters may only follow uncased
     |      characters and lowercase characters only cased ones. Return False
     |      otherwise.
     |  
     |  isupper(...)
     |      B.isupper() -> bool
     |      
     |      Return True if all cased characters in B are uppercase and there is
     |      at least one cased character in B, False otherwise.
     |  
     |  join(self, iterable_of_bytes, /)
     |      Concatenate any number of bytes objects.
     |      
     |      The bytes whose method is called is inserted in between each pair.
     |      
     |      The result is returned as a new bytes object.
     |      
     |      Example: b'.'.join([b'ab', b'pq', b'rs']) -> b'ab.pq.rs'.
     |  
     |  ljust(...)
     |      B.ljust(width[, fillchar]) -> copy of B
     |      
     |      Return B left justified in a string of length width. Padding is
     |      done using the specified fill character (default is a space).
     |  
     |  lower(...)
     |      B.lower() -> copy of B
     |      
     |      Return a copy of B with all ASCII characters converted to lowercase.
     |  
     |  lstrip(self, bytes=None, /)
     |      Strip leading bytes contained in the argument.
     |      
     |      If the argument is omitted or None, strip leading  ASCII whitespace.
     |  
     |  partition(self, sep, /)
     |      Partition the bytes into three parts using the given separator.
     |      
     |      This will search for the separator sep in the bytes. If the separator is found,
     |      returns a 3-tuple containing the part before the separator, the separator
     |      itself, and the part after it.
     |      
     |      If the separator is not found, returns a 3-tuple containing the original bytes
     |      object and two empty bytes objects.
     |  
     |  replace(self, old, new, count=-1, /)
     |      Return a copy with all occurrences of substring old replaced by new.
     |      
     |        count
     |          Maximum number of occurrences to replace.
     |          -1 (the default value) means replace all occurrences.
     |      
     |      If the optional argument count is given, only the first count occurrences are
     |      replaced.
     |  
     |  rfind(...)
     |      B.rfind(sub[, start[, end]]) -> int
     |      
     |      Return the highest index in B where subsection sub is found,
     |      such that sub is contained within B[start,end].  Optional
     |      arguments start and end are interpreted as in slice notation.
     |      
     |      Return -1 on failure.
     |  
     |  rindex(...)
     |      B.rindex(sub[, start[, end]]) -> int
     |      
     |      Return the highest index in B where subsection sub is found,
     |      such that sub is contained within B[start,end].  Optional
     |      arguments start and end are interpreted as in slice notation.
     |      
     |      Raise ValueError when the subsection is not found.
     |  
     |  rjust(...)
     |      B.rjust(width[, fillchar]) -> copy of B
     |      
     |      Return B right justified in a string of length width. Padding is
     |      done using the specified fill character (default is a space)
     |  
     |  rpartition(self, sep, /)
     |      Partition the bytes into three parts using the given separator.
     |      
     |      This will search for the separator sep in the bytes, starting at the end. If
     |      the separator is found, returns a 3-tuple containing the part before the
     |      separator, the separator itself, and the part after it.
     |      
     |      If the separator is not found, returns a 3-tuple containing two empty bytes
     |      objects and the original bytes object.
     |  
     |  rsplit(self, /, sep=None, maxsplit=-1)
     |      Return a list of the sections in the bytes, using sep as the delimiter.
     |      
     |        sep
     |          The delimiter according which to split the bytes.
     |          None (the default value) means split on ASCII whitespace characters
     |          (space, tab, return, newline, formfeed, vertical tab).
     |        maxsplit
     |          Maximum number of splits to do.
     |          -1 (the default value) means no limit.
     |      
     |      Splitting is done starting at the end of the bytes and working to the front.
     |  
     |  rstrip(self, bytes=None, /)
     |      Strip trailing bytes contained in the argument.
     |      
     |      If the argument is omitted or None, strip trailing ASCII whitespace.
     |  
     |  split(self, /, sep=None, maxsplit=-1)
     |      Return a list of the sections in the bytes, using sep as the delimiter.
     |      
     |      sep
     |        The delimiter according which to split the bytes.
     |        None (the default value) means split on ASCII whitespace characters
     |        (space, tab, return, newline, formfeed, vertical tab).
     |      maxsplit
     |        Maximum number of splits to do.
     |        -1 (the default value) means no limit.
     |  
     |  splitlines(self, /, keepends=False)
     |      Return a list of the lines in the bytes, breaking at line boundaries.
     |      
     |      Line breaks are not included in the resulting list unless keepends is given and
     |      true.
     |  
     |  startswith(...)
     |      B.startswith(prefix[, start[, end]]) -> bool
     |      
     |      Return True if B starts with the specified prefix, False otherwise.
     |      With optional start, test B beginning at that position.
     |      With optional end, stop comparing B at that position.
     |      prefix can also be a tuple of bytes to try.
     |  
     |  strip(self, bytes=None, /)
     |      Strip leading and trailing bytes contained in the argument.
     |      
     |      If the argument is omitted or None, strip leading and trailing ASCII whitespace.
     |  
     |  swapcase(...)
     |      B.swapcase() -> copy of B
     |      
     |      Return a copy of B with uppercase ASCII characters converted
     |      to lowercase ASCII and vice versa.
     |  
     |  title(...)
     |      B.title() -> copy of B
     |      
     |      Return a titlecased version of B, i.e. ASCII words start with uppercase
     |      characters, all remaining cased characters have lowercase.
     |  
     |  translate(self, table, /, delete=b'')
     |      Return a copy with each character mapped by the given translation table.
     |      
     |        table
     |          Translation table, which must be a bytes object of length 256.
     |      
     |      All characters occurring in the optional argument delete are removed.
     |      The remaining characters are mapped through the given translation table.
     |  
     |  upper(...)
     |      B.upper() -> copy of B
     |      
     |      Return a copy of B with all ASCII characters converted to uppercase.
     |  
     |  zfill(...)
     |      B.zfill(width) -> copy of B
     |      
     |      Pad a numeric string B with zeros on the left, to fill a field
     |      of the specified width.  B is never truncated.
     |  
     |  ----------------------------------------------------------------------
     |  Class methods defined here:
     |  
     |  fromhex(string, /) from builtins.type
     |      Create a bytes object from a string of hexadecimal numbers.
     |      
     |      Spaces between two numbers are accepted.
     |      Example: bytes.fromhex('B9 01EF') -> b'\\xb9\\x01\\xef'.
     |  
     |  ----------------------------------------------------------------------
     |  Static methods defined here:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  maketrans(frm, to, /)
     |      Return a translation table useable for the bytes or bytearray translate method.
     |      
     |      The returned table will be one where each byte in frm is mapped to the byte at
     |      the same position in to.
     |      
     |      The bytes objects frm and to must be of the same length.
    
    class CMySQLConnection(mysql.connector.abstracts.MySQLConnectionAbstract)
     |  CMySQLConnection(**kwargs)
     |  
     |  Class initiating a MySQL Connection using Connector/C
     |  
     |  Method resolution order:
     |      CMySQLConnection
     |      mysql.connector.abstracts.MySQLConnectionAbstract
     |      mysql.connector.abstracts.MySQLConnectionAbstract
     |      builtins.object
     |  
     |  Methods defined here:
     |  
     |  __init__(self, **kwargs)
     |      Initialization
     |  
     |  close(self)
     |      Disconnect from the MySQL server
     |  
     |  cmd_change_user(self, username='', password='', database='', charset=45)
     |      Change the current logged in user
     |  
     |  cmd_init_db(self, database)
     |      Change the current database
     |  
     |  cmd_process_kill(self, mysql_pid)
     |      Kill a MySQL process
     |  
     |  cmd_query(self, query, raw=None, buffered=False, raw_as_string=False)
     |      Send a query to the MySQL server
     |  
     |  cmd_quit(self)
     |      Close the current connection with the server
     |  
     |  cmd_refresh(self, options)
     |      Send the Refresh command to the MySQL server
     |  
     |  cmd_shutdown(self, shutdown_type=None)
     |      Shut down the MySQL Server
     |  
     |  cmd_statistics(self)
     |      Return statistics from the MySQL server
     |  
     |  commit(self)
     |      Commit current transaction
     |  
     |  consume_results(self)
     |      Consume the current result
     |      
     |      This method consume the result by reading (consuming) all rows.
     |  
     |  cursor(self, buffered=None, raw=None, prepared=None, cursor_class=None, dictionary=None, named_tuple=None)
     |      Instantiates and returns a cursor using C Extension
     |      
     |      By default, CMySQLCursor is returned. Depending on the options
     |      while connecting, a buffered and/or raw cursor is instantiated
     |      instead. Also depending upon the cursor options, rows can be
     |      returned as dictionary or named tuple.
     |      
     |      Dictionary and namedtuple based cursors are available with buffered
     |      output but not raw.
     |      
     |      It is possible to also give a custom cursor through the
     |      cursor_class parameter, but it needs to be a subclass of
     |      mysql.connector.cursor_cext.CMySQLCursor.
     |      
     |      Raises ProgrammingError when cursor_class is not a subclass of
     |      CursorBase. Raises ValueError when cursor is not available.
     |      
     |      Returns instance of CMySQLCursor or subclass.
     |      
     |      :param buffered: Return a buffering cursor
     |      :param raw: Return a raw cursor
     |      :param prepared: Return a cursor which uses prepared statements
     |      :param cursor_class: Use a custom cursor class
     |      :param dictionary: Rows are returned as dictionary
     |      :param named_tuple: Rows are returned as named tuple
     |      :return: Subclass of CMySQLCursor
     |      :rtype: CMySQLCursor or subclass
     |  
     |  disconnect = close(self)
     |  
     |  fetch_eof_columns(self)
     |      Fetch EOF and column information
     |  
     |  fetch_eof_status(self)
     |      Fetch EOF and status information
     |  
     |  free_result(self)
     |      Frees the result
     |  
     |  get_row(self, binary=False, columns=None, raw=None)
     |      Get the next rows returned by the MySQL server
     |  
     |  get_rows(self, count=None, binary=False, columns=None, raw=None)
     |      Get all or a subset of rows returned by the MySQL server
     |  
     |  handle_unread_result(self)
     |      Check whether there is an unread result
     |  
     |  info_query(self, query)
     |      Send a query which only returns 1 row
     |  
     |  is_connected(self)
     |      Reports whether the connection to MySQL Server is available
     |  
     |  next_result(self)
     |      Reads the next result
     |  
     |  ping(self, reconnect=False, attempts=1, delay=0)
     |      Check availability of the MySQL server
     |      
     |      When reconnect is set to True, one or more attempts are made to try
     |      to reconnect to the MySQL server using the reconnect()-method.
     |      
     |      delay is the number of seconds to wait between each retry.
     |      
     |      When the connection is not available, an InterfaceError is raised. Use
     |      the is_connected()-method if you just want to check the connection
     |      without raising an error.
     |      
     |      Raises InterfaceError on errors.
     |  
     |  prepare_for_mysql(self, params)
     |      Prepare parameters for statements
     |      
     |      This method is use by cursors to prepared parameters found in the
     |      list (or tuple) params.
     |      
     |      Returns dict.
     |  
     |  rollback(self)
     |      Rollback current transaction
     |  
     |  set_character_set_name(self, charset)
     |      Sets the default character set name for current connection.
     |  
     |  set_unicode(self, value=True)
     |      Toggle unicode mode
     |      
     |      Set whether we return string fields as unicode or not.
     |      Default is True.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  autocommit
     |      Get whether autocommit is on or off
     |  
     |  connection_id
     |      MySQL connection ID
     |  
     |  database
     |      Get the current database
     |  
     |  in_transaction
     |      MySQL session has started a transaction
     |  
     |  more_results
     |      Check if there are more results
     |  
     |  num_rows
     |      Returns number of rows of current result set
     |  
     |  result_set_available
     |      Check if a result set is available
     |  
     |  unread_result
     |      Check if there are unread results or rows
     |  
     |  warning_count
     |      Returns number of warnings
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |  
     |  __abstractmethods__ = frozenset()
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from mysql.connector.abstracts.MySQLConnectionAbstract:
     |  
     |  cmd_debug(self)
     |      Send the DEBUG command
     |  
     |  cmd_ping(self)
     |      Send the PING command
     |  
     |  cmd_process_info(self)
     |      Get the process list of the MySQL Server
     |      
     |      This method is a placeholder to notify that the PROCESS_INFO command
     |      is not supported by raising the NotSupportedError. The command
     |      "SHOW PROCESSLIST" should be send using the cmd_query()-method or
     |      using the INFORMATION_SCHEMA database.
     |      
     |      Raises NotSupportedError exception
     |  
     |  cmd_query_iter(self, statements)
     |      Send one or more statements to the MySQL server
     |  
     |  cmd_reset_connection(self)
     |      Resets the session state without re-authenticating
     |  
     |  cmd_stmt_close(self, statement_id)
     |      Deallocate a prepared MySQL statement
     |  
     |  cmd_stmt_execute(self, statement_id, data=(), parameters=(), flags=0)
     |      Execute a prepared MySQL statement
     |  
     |  cmd_stmt_prepare(self, statement)
     |      Prepare a MySQL statement
     |  
     |  cmd_stmt_reset(self, statement_id)
     |      Reset data for prepared statement sent as long data
     |  
     |  cmd_stmt_send_long_data(self, statement_id, param_id, data)
     |      Send data for a column
     |  
     |  config(self, **kwargs)
     |      Configure the MySQL Connection
     |      
     |      This method allows you to configure the MySQLConnection instance.
     |      
     |      Raises on errors.
     |  
     |  connect(self, **kwargs)
     |      Connect to the MySQL server
     |      
     |      This method sets up the connection to the MySQL server. If no
     |      arguments are given, it will use the already configured or default
     |      values.
     |  
     |  get_server_info(self)
     |      Get the original MySQL version information
     |      
     |      This method returns the original MySQL server as text. If not
     |      previously connected, it will return None.
     |      
     |      Returns a string or None.
     |  
     |  get_server_version(self)
     |      Get the MySQL version
     |      
     |      This method returns the MySQL server version as a tuple. If not
     |      previously connected, it will return None.
     |      
     |      Returns a tuple or None.
     |  
     |  isset_client_flag(self, flag)
     |      Check if a client flag is set
     |  
     |  reconnect(self, attempts=1, delay=0)
     |      Attempt to reconnect to the MySQL server
     |      
     |      The argument attempts should be the number of times a reconnect
     |      is tried. The delay argument is the number of seconds to wait between
     |      each retry.
     |      
     |      You may want to set the number of attempts higher and use delay when
     |      you expect the MySQL server to be down for maintenance or when you
     |      expect the network to be temporary unavailable.
     |      
     |      Raises InterfaceError on errors.
     |  
     |  reset_session(self, user_variables=None, session_variables=None)
     |      Clears the current active session
     |      
     |      This method resets the session state, if the MySQL server is 5.7.3
     |      or later active session will be reset without re-authenticating.
     |      For other server versions session will be reset by re-authenticating.
     |      
     |      It is possible to provide a sequence of variables and their values to
     |      be set after clearing the session. This is possible for both user
     |      defined variables and session variables.
     |      This method takes two arguments user_variables and session_variables
     |      which are dictionaries.
     |      
     |      Raises OperationalError if not connected, InternalError if there are
     |      unread results and InterfaceError on errors.
     |  
     |  set_charset_collation(self, charset=None, collation=None)
     |      Sets the character set and collation for the current connection
     |      
     |      This method sets the character set and collation to be used for
     |      the current connection. The charset argument can be either the
     |      name of a character set as a string, or the numerical equivalent
     |      as defined in constants.CharacterSet.
     |      
     |      When the collation is not given, the default will be looked up and
     |      used.
     |      
     |      For example, the following will set the collation for the latin1
     |      character set to latin1_general_ci:
     |      
     |         set_charset('latin1','latin1_general_ci')
     |  
     |  set_client_flags(self, flags)
     |      Set the client flags
     |      
     |      The flags-argument can be either an int or a list (or tuple) of
     |      ClientFlag-values. If it is an integer, it will set client_flags
     |      to flags as is.
     |      If flags is a list (or tuple), each flag will be set or unset
     |      when it is negative.
     |      
     |      set_client_flags([ClientFlag.FOUND_ROWS,-ClientFlag.LONG_FLAG])
     |      
     |      Raises ProgrammingError when the flags argument is not a set or
     |      an integer bigger than 0.
     |      
     |      Returns self.client_flags
     |  
     |  set_converter_class(self, convclass)
     |      Set the converter class to be used. This should be a class overloading
     |      methods and members of conversion.MySQLConverter.
     |  
     |  set_login(self, username=None, password=None)
     |      Set login information for MySQL
     |      
     |      Set the username and/or password for the user connecting to
     |      the MySQL Server.
     |  
     |  start_transaction(self, consistent_snapshot=False, isolation_level=None, readonly=None)
     |      Start a transaction
     |      
     |      This method explicitly starts a transaction sending the
     |      START TRANSACTION statement to the MySQL server. You can optionally
     |      set whether there should be a consistent snapshot, which
     |      isolation level you need or which access mode i.e. READ ONLY or
     |      READ WRITE.
     |      
     |      For example, to start a transaction with isolation level SERIALIZABLE,
     |      you would do the following:
     |          >>> cnx = mysql.connector.connect(..)
     |          >>> cnx.start_transaction(isolation_level='SERIALIZABLE')
     |      
     |      Raises ProgrammingError when a transaction is already in progress
     |      and when ValueError when isolation_level specifies an Unknown
     |      level.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from mysql.connector.abstracts.MySQLConnectionAbstract:
     |  
     |  can_consume_results
     |      Returns whether to consume results
     |  
     |  charset
     |      Returns the character set for current connection
     |      
     |      This property returns the character set name of the current connection.
     |      The server is queried when the connection is active. If not connected,
     |      the configured character set name is returned.
     |      
     |      Returns a string.
     |  
     |  collation
     |      Returns the collation for current connection
     |      
     |      This property returns the collation name of the current connection.
     |      The server is queried when the connection is active. If not connected,
     |      the configured collation name is returned.
     |      
     |      Returns a string.
     |  
     |  get_warnings
     |      Get whether this connection retrieves warnings automatically
     |      
     |      This method returns whether this connection retrieves warnings
     |      automatically.
     |      
     |      Returns True, or False when warnings are not retrieved.
     |  
     |  python_charset
     |      Returns the Python character set for current connection
     |      
     |      This property returns the character set name of the current connection.
     |      Note that, unlike property charset, this checks if the previously set
     |      character set is supported by Python and if not, it returns the
     |      equivalent character set that Python supports.
     |      
     |      Returns a string.
     |  
     |  raise_on_warnings
     |      Get whether this connection raises an error on warnings
     |      
     |      This method returns whether this connection will raise errors when
     |      MySQL reports warnings.
     |      
     |      Returns True or False.
     |  
     |  server_host
     |      MySQL server IP address or name
     |  
     |  server_port
     |      MySQL server TCP/IP port
     |  
     |  sql_mode
     |      Get the SQL mode
     |  
     |  time_zone
     |      Get the current time zone
     |  
     |  unix_socket
     |      MySQL Unix socket file location
     |  
     |  user
     |      User used while connecting to MySQL
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from mysql.connector.abstracts.MySQLConnectionAbstract:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
    
    class CharacterSet(_Constants)
     |  MySQL supported character sets and collations
     |  
     |  List of character sets with their collations supported by MySQL. This
     |  maps to the character set we get from the server within the handshake
     |  packet.
     |  
     |  The list is hardcode so we avoid a database query when getting the
     |  name of the used character set or collation.
     |  
     |  Method resolution order:
     |      CharacterSet
     |      _Constants
     |      builtins.object
     |  
     |  Class methods defined here:
     |  
     |  get_charset_info(charset=None, collation=None) from builtins.type
     |      Get character set information using charset name and/or collation
     |      
     |      Retrieves character set and collation information given character
     |      set name and/or a collation name.
     |      If charset is an integer, it will look up the character set based
     |      on the MySQL's ID.
     |      For example:
     |          get_charset_info('utf8',None)
     |          get_charset_info(collation='utf8_general_ci')
     |          get_charset_info(47)
     |      
     |      Raises ProgrammingError when character set is not supported.
     |      
     |      Returns a tuple with (id, characterset name, collation)
     |  
     |  get_default_collation(charset) from builtins.type
     |      Retrieves the default collation for given character set
     |      
     |      Raises ProgrammingError when character set is not supported.
     |      
     |      Returns list (collation, charset, index)
     |  
     |  get_desc(name) from builtins.type
     |      Retrieves character set information as string using an ID
     |      
     |      Retrieves character set and collation information based on the
     |      given MySQL ID.
     |      
     |      Returns a tuple.
     |  
     |  get_info(setid) from builtins.type
     |      Retrieves character set information as tuple using an ID
     |      
     |      Retrieves character set and collation information based on the
     |      given MySQL ID.
     |      
     |      Raises ProgrammingError when character set is not supported.
     |      
     |      Returns a tuple.
     |  
     |  get_supported() from builtins.type
     |      Retrieves a list with names of all supproted character sets
     |      
     |      Returns a tuple.
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |  
     |  desc = [None, ('big5', 'big5_chinese_ci', True), ('latin2', 'latin2_cz...
     |  
     |  slash_charsets = (1, 13, 28, 84, 87, 88)
     |  
     |  ----------------------------------------------------------------------
     |  Class methods inherited from _Constants:
     |  
     |  get_full_info() from builtins.type
     |      get full information about given constant
     |  
     |  ----------------------------------------------------------------------
     |  Static methods inherited from _Constants:
     |  
     |  __new__(cls)
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from _Constants:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes inherited from _Constants:
     |  
     |  prefix = ''
    
    class ClientFlag(_Flags)
     |  MySQL Client Flags
     |  
     |  Client options as found in the MySQL sources mysql-src/include/mysql_com.h
     |  
     |  Method resolution order:
     |      ClientFlag
     |      _Flags
     |      _Constants
     |      builtins.object
     |  
     |  Class methods defined here:
     |  
     |  get_default() from builtins.type
     |      Get the default client options set
     |      
     |      Returns a flag with all the default client options set
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |  
     |  CAN_HANDLE_EXPIRED_PASSWORDS = 4194304
     |  
     |  COMPRESS = 32
     |  
     |  CONNECT_ARGS = 1048576
     |  
     |  CONNECT_WITH_DB = 8
     |  
     |  DEPRECATE_EOF = 16777216
     |  
     |  FOUND_ROWS = 2
     |  
     |  IGNORE_SIGPIPE = 4096
     |  
     |  IGNORE_SPACE = 256
     |  
     |  INTERACTIVE = 1024
     |  
     |  LOCAL_FILES = 128
     |  
     |  LONG_FLAG = 4
     |  
     |  LONG_PASSWD = 1
     |  
     |  MULTI_RESULTS = 131072
     |  
     |  MULTI_STATEMENTS = 65536
     |  
     |  NO_SCHEMA = 16
     |  
     |  ODBC = 64
     |  
     |  PLUGIN_AUTH = 524288
     |  
     |  PLUGIN_AUTH_LENENC_CLIENT_DATA = 2097152
     |  
     |  PROTOCOL_41 = 512
     |  
     |  PS_MULTI_RESULTS = 262144
     |  
     |  REMEMBER_OPTIONS = 2147483648
     |  
     |  RESERVED = 16384
     |  
     |  SECURE_CONNECTION = 32768
     |  
     |  SESION_TRACK = 8388608
     |  
     |  SSL = 2048
     |  
     |  SSL_VERIFY_SERVER_CERT = 1073741824
     |  
     |  TRANSACTIONS = 8192
     |  
     |  default = [1, 4, 8, 512, 8192, 32768, 65536, 131072]
     |  
     |  desc = {'CAN_HANDLE_EXPIRED_PASSWORDS': (4194304, "Don't close the con...
     |  
     |  ----------------------------------------------------------------------
     |  Class methods inherited from _Flags:
     |  
     |  get_bit_info(value) from builtins.type
     |      Get the name of all bits set
     |      
     |      Returns a list of strings.
     |  
     |  ----------------------------------------------------------------------
     |  Class methods inherited from _Constants:
     |  
     |  get_desc(name) from builtins.type
     |      Get description of given constant
     |  
     |  get_full_info() from builtins.type
     |      get full information about given constant
     |  
     |  get_info(setid) from builtins.type
     |      Get information about given constant
     |  
     |  ----------------------------------------------------------------------
     |  Static methods inherited from _Constants:
     |  
     |  __new__(cls)
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from _Constants:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes inherited from _Constants:
     |  
     |  prefix = ''
    
    class DataError(DatabaseError)
     |  DataError(msg=None, errno=None, values=None, sqlstate=None)
     |  
     |  Exception for errors reporting problems with processed data
     |  
     |  Method resolution order:
     |      DataError
     |      DatabaseError
     |      Error
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |  
     |  Methods inherited from Error:
     |  
     |  __init__(self, msg=None, errno=None, values=None, sqlstate=None)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  __str__(self)
     |      Return str(self).
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from Error:
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.Exception:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |  
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |  
     |  __setstate__(...)
     |  
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |  
     |  __cause__
     |      exception cause
     |  
     |  __context__
     |      exception context
     |  
     |  __dict__
     |  
     |  __suppress_context__
     |  
     |  __traceback__
     |  
     |  args
    
    class DatabaseError(Error)
     |  DatabaseError(msg=None, errno=None, values=None, sqlstate=None)
     |  
     |  Exception for errors related to the database
     |  
     |  Method resolution order:
     |      DatabaseError
     |      Error
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |  
     |  Methods inherited from Error:
     |  
     |  __init__(self, msg=None, errno=None, values=None, sqlstate=None)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  __str__(self)
     |      Return str(self).
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from Error:
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.Exception:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |  
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |  
     |  __setstate__(...)
     |  
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |  
     |  __cause__
     |      exception cause
     |  
     |  __context__
     |      exception context
     |  
     |  __dict__
     |  
     |  __suppress_context__
     |  
     |  __traceback__
     |  
     |  args
    
    Date = class date(builtins.object)
     |  date(year, month, day) --> date object
     |  
     |  Methods defined here:
     |  
     |  __add__(self, value, /)
     |      Return self+value.
     |  
     |  __eq__(self, value, /)
     |      Return self==value.
     |  
     |  __format__(...)
     |      Formats self with strftime.
     |  
     |  __ge__(self, value, /)
     |      Return self>=value.
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __gt__(self, value, /)
     |      Return self>value.
     |  
     |  __hash__(self, /)
     |      Return hash(self).
     |  
     |  __le__(self, value, /)
     |      Return self<=value.
     |  
     |  __lt__(self, value, /)
     |      Return self<value.
     |  
     |  __ne__(self, value, /)
     |      Return self!=value.
     |  
     |  __radd__(self, value, /)
     |      Return value+self.
     |  
     |  __reduce__(...)
     |      __reduce__() -> (cls, state)
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  __rsub__(self, value, /)
     |      Return value-self.
     |  
     |  __str__(self, /)
     |      Return str(self).
     |  
     |  __sub__(self, value, /)
     |      Return self-value.
     |  
     |  ctime(...)
     |      Return ctime() style string.
     |  
     |  isocalendar(...)
     |      Return a 3-tuple containing ISO year, week number, and weekday.
     |  
     |  isoformat(...)
     |      Return string in ISO 8601 format, YYYY-MM-DD.
     |  
     |  isoweekday(...)
     |      Return the day of the week represented by the date.
     |      Monday == 1 ... Sunday == 7
     |  
     |  replace(...)
     |      Return date with new specified fields.
     |  
     |  strftime(...)
     |      format -> strftime() style string.
     |  
     |  timetuple(...)
     |      Return time tuple, compatible with time.localtime().
     |  
     |  toordinal(...)
     |      Return proleptic Gregorian ordinal.  January 1 of year 1 is day 1.
     |  
     |  weekday(...)
     |      Return the day of the week represented by the date.
     |      Monday == 0 ... Sunday == 6
     |  
     |  ----------------------------------------------------------------------
     |  Class methods defined here:
     |  
     |  fromisoformat(...) from builtins.type
     |      str -> Construct a date from the output of date.isoformat()
     |  
     |  fromordinal(...) from builtins.type
     |      int -> date corresponding to a proleptic Gregorian ordinal.
     |  
     |  fromtimestamp(...) from builtins.type
     |      timestamp -> local date from a POSIX timestamp (like time.time()).
     |  
     |  today(...) from builtins.type
     |      Current date or datetime:  same as self.__class__.fromtimestamp(time.time()).
     |  
     |  ----------------------------------------------------------------------
     |  Static methods defined here:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  day
     |  
     |  month
     |  
     |  year
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |  
     |  max = datetime.date(9999, 12, 31)
     |  
     |  min = datetime.date(1, 1, 1)
     |  
     |  resolution = datetime.timedelta(days=1)
    
    class Error(builtins.Exception)
     |  Error(msg=None, errno=None, values=None, sqlstate=None)
     |  
     |  Exception that is base class for all other error exceptions
     |  
     |  Method resolution order:
     |      Error
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |  
     |  Methods defined here:
     |  
     |  __init__(self, msg=None, errno=None, values=None, sqlstate=None)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  __str__(self)
     |      Return str(self).
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.Exception:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |  
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |  
     |  __setstate__(...)
     |  
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |  
     |  __cause__
     |      exception cause
     |  
     |  __context__
     |      exception context
     |  
     |  __dict__
     |  
     |  __suppress_context__
     |  
     |  __traceback__
     |  
     |  args
    
    class FieldFlag(_Flags)
     |  MySQL Field Flags
     |  
     |  Field flags as found in MySQL sources mysql-src/include/mysql_com.h
     |  
     |  Method resolution order:
     |      FieldFlag
     |      _Flags
     |      _Constants
     |      builtins.object
     |  
     |  Data and other attributes defined here:
     |  
     |  AUTO_INCREMENT = 512
     |  
     |  BINARY = 128
     |  
     |  BINCMP = 131072
     |  
     |  BLOB = 16
     |  
     |  ENUM = 256
     |  
     |  FIELD_IN_ADD_INDEX = 1048576
     |  
     |  FIELD_IN_PART_FUNC = 524288
     |  
     |  FIELD_IS_RENAMED = 2097152
     |  
     |  GET_FIXED_FIELDS = 262144
     |  
     |  GROUP = 16384
     |  
     |  MULTIPLE_KEY = 8
     |  
     |  NOT_NULL = 1
     |  
     |  NO_DEFAULT_VALUE = 4096
     |  
     |  NUM = 16384
     |  
     |  ON_UPDATE_NOW = 8192
     |  
     |  PART_KEY = 32768
     |  
     |  PRI_KEY = 2
     |  
     |  SET = 2048
     |  
     |  TIMESTAMP = 1024
     |  
     |  UNIQUE = 65536
     |  
     |  UNIQUE_KEY = 4
     |  
     |  UNSIGNED = 32
     |  
     |  ZEROFILL = 64
     |  
     |  desc = {'AUTO_INCREMENT': (512, 'field is a autoincrement field'), 'BI...
     |  
     |  ----------------------------------------------------------------------
     |  Class methods inherited from _Flags:
     |  
     |  get_bit_info(value) from builtins.type
     |      Get the name of all bits set
     |      
     |      Returns a list of strings.
     |  
     |  ----------------------------------------------------------------------
     |  Class methods inherited from _Constants:
     |  
     |  get_desc(name) from builtins.type
     |      Get description of given constant
     |  
     |  get_full_info() from builtins.type
     |      get full information about given constant
     |  
     |  get_info(setid) from builtins.type
     |      Get information about given constant
     |  
     |  ----------------------------------------------------------------------
     |  Static methods inherited from _Constants:
     |  
     |  __new__(cls)
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from _Constants:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes inherited from _Constants:
     |  
     |  prefix = ''
    
    class FieldType(_Constants)
     |  MySQL Field Types
     |  
     |  Method resolution order:
     |      FieldType
     |      _Constants
     |      builtins.object
     |  
     |  Class methods defined here:
     |  
     |  get_binary_types() from builtins.type
     |      Get the list of all binary types
     |  
     |  get_number_types() from builtins.type
     |      Get the list of all number types
     |  
     |  get_string_types() from builtins.type
     |      Get the list of all string types
     |  
     |  get_timestamp_types() from builtins.type
     |      Get the list of all timestamp types
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |  
     |  BIT = 16
     |  
     |  BLOB = 252
     |  
     |  DATE = 10
     |  
     |  DATETIME = 12
     |  
     |  DECIMAL = 0
     |  
     |  DOUBLE = 5
     |  
     |  ENUM = 247
     |  
     |  FLOAT = 4
     |  
     |  GEOMETRY = 255
     |  
     |  INT24 = 9
     |  
     |  JSON = 245
     |  
     |  LONG = 3
     |  
     |  LONGLONG = 8
     |  
     |  LONG_BLOB = 251
     |  
     |  MEDIUM_BLOB = 250
     |  
     |  NEWDATE = 14
     |  
     |  NEWDECIMAL = 246
     |  
     |  NULL = 6
     |  
     |  SET = 248
     |  
     |  SHORT = 2
     |  
     |  STRING = 254
     |  
     |  TIME = 11
     |  
     |  TIMESTAMP = 7
     |  
     |  TINY = 1
     |  
     |  TINY_BLOB = 249
     |  
     |  VARCHAR = 15
     |  
     |  VAR_STRING = 253
     |  
     |  YEAR = 13
     |  
     |  desc = {'BIT': (16, 'BIT'), 'BLOB': (252, 'BLOB'), 'DATE': (10, 'DATE'...
     |  
     |  prefix = 'FIELD_TYPE_'
     |  
     |  ----------------------------------------------------------------------
     |  Class methods inherited from _Constants:
     |  
     |  get_desc(name) from builtins.type
     |      Get description of given constant
     |  
     |  get_full_info() from builtins.type
     |      get full information about given constant
     |  
     |  get_info(setid) from builtins.type
     |      Get information about given constant
     |  
     |  ----------------------------------------------------------------------
     |  Static methods inherited from _Constants:
     |  
     |  __new__(cls)
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from _Constants:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
    
    class IntegrityError(DatabaseError)
     |  IntegrityError(msg=None, errno=None, values=None, sqlstate=None)
     |  
     |  Exception for errors regarding relational integrity
     |  
     |  Method resolution order:
     |      IntegrityError
     |      DatabaseError
     |      Error
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |  
     |  Methods inherited from Error:
     |  
     |  __init__(self, msg=None, errno=None, values=None, sqlstate=None)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  __str__(self)
     |      Return str(self).
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from Error:
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.Exception:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |  
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |  
     |  __setstate__(...)
     |  
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |  
     |  __cause__
     |      exception cause
     |  
     |  __context__
     |      exception context
     |  
     |  __dict__
     |  
     |  __suppress_context__
     |  
     |  __traceback__
     |  
     |  args
    
    class InterfaceError(Error)
     |  InterfaceError(msg=None, errno=None, values=None, sqlstate=None)
     |  
     |  Exception for errors related to the interface
     |  
     |  Method resolution order:
     |      InterfaceError
     |      Error
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |  
     |  Methods inherited from Error:
     |  
     |  __init__(self, msg=None, errno=None, values=None, sqlstate=None)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  __str__(self)
     |      Return str(self).
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from Error:
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.Exception:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |  
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |  
     |  __setstate__(...)
     |  
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |  
     |  __cause__
     |      exception cause
     |  
     |  __context__
     |      exception context
     |  
     |  __dict__
     |  
     |  __suppress_context__
     |  
     |  __traceback__
     |  
     |  args
    
    class InternalError(DatabaseError)
     |  InternalError(msg=None, errno=None, values=None, sqlstate=None)
     |  
     |  Exception for errors internal database errors
     |  
     |  Method resolution order:
     |      InternalError
     |      DatabaseError
     |      Error
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |  
     |  Methods inherited from Error:
     |  
     |  __init__(self, msg=None, errno=None, values=None, sqlstate=None)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  __str__(self)
     |      Return str(self).
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from Error:
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.Exception:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |  
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |  
     |  __setstate__(...)
     |  
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |  
     |  __cause__
     |      exception cause
     |  
     |  __context__
     |      exception context
     |  
     |  __dict__
     |  
     |  __suppress_context__
     |  
     |  __traceback__
     |  
     |  args
    
    class MySQLConnection(mysql.connector.abstracts.MySQLConnectionAbstract)
     |  MySQLConnection(*args, **kwargs)
     |  
     |  Connection to a MySQL Server
     |  
     |  Method resolution order:
     |      MySQLConnection
     |      mysql.connector.abstracts.MySQLConnectionAbstract
     |      mysql.connector.abstracts.MySQLConnectionAbstract
     |      builtins.object
     |  
     |  Methods defined here:
     |  
     |  __init__(self, *args, **kwargs)
     |      Initialize
     |  
     |  close(self)
     |      Disconnect from the MySQL server
     |  
     |  cmd_change_user(self, username='', password='', database='', charset=45)
     |      Change the current logged in user
     |      
     |      This method allows to change the current logged in user information.
     |      The result is a dictionary with OK packet information.
     |      
     |      Returns a dict()
     |  
     |  cmd_debug(self)
     |      Send the DEBUG command
     |      
     |      This method sends the DEBUG command to the MySQL server, which
     |      requires the MySQL user to have SUPER privilege. The output will go
     |      to the MySQL server error log and the result of this method is a
     |      dictionary with EOF packet information.
     |      
     |      Returns a dict()
     |  
     |  cmd_init_db(self, database)
     |      Change the current database
     |      
     |      This method changes the current (default) database by sending the
     |      INIT_DB command. The result is a dictionary containing the OK packet
     |      information.
     |      
     |      Returns a dict()
     |  
     |  cmd_ping(self)
     |      Send the PING command
     |      
     |      This method sends the PING command to the MySQL server. It is used to
     |      check if the the connection is still valid. The result of this
     |      method is dictionary with OK packet information.
     |      
     |      Returns a dict()
     |  
     |  cmd_process_kill(self, mysql_pid)
     |      Kill a MySQL process
     |      
     |      This method send the PROCESS_KILL command to the server along with
     |      the process ID. The result is a dictionary with the OK packet
     |      information.
     |      
     |      Returns a dict()
     |  
     |  cmd_query(self, query, raw=False, buffered=False, raw_as_string=False)
     |      Send a query to the MySQL server
     |      
     |      This method send the query to the MySQL server and returns the result.
     |      
     |      If there was a text result, a tuple will be returned consisting of
     |      the number of columns and a list containing information about these
     |      columns.
     |      
     |      When the query doesn't return a text result, the OK or EOF packet
     |      information as dictionary will be returned. In case the result was
     |      an error, exception errors.Error will be raised.
     |      
     |      Returns a tuple()
     |  
     |  cmd_query_iter(self, statements)
     |      Send one or more statements to the MySQL server
     |      
     |      Similar to the cmd_query method, but instead returns a generator
     |      object to iterate through results. It sends the statements to the
     |      MySQL server and through the iterator you can get the results.
     |      
     |      statement = 'SELECT 1; INSERT INTO t1 VALUES (); SELECT 2'
     |      for result in cnx.cmd_query(statement, iterate=True):
     |          if 'columns' in result:
     |              columns = result['columns']
     |              rows = cnx.get_rows()
     |          else:
     |              # do something useful with INSERT result
     |      
     |      Returns a generator.
     |  
     |  cmd_quit(self)
     |      Close the current connection with the server
     |      
     |      This method sends the QUIT command to the MySQL server, closing the
     |      current connection. Since the no response can be returned to the
     |      client, cmd_quit() will return the packet it send.
     |      
     |      Returns a str()
     |  
     |  cmd_refresh(self, options)
     |      Send the Refresh command to the MySQL server
     |      
     |      This method sends the Refresh command to the MySQL server. The options
     |      argument should be a bitwise value using constants.RefreshOption.
     |      Usage example:
     |       RefreshOption = mysql.connector.RefreshOption
     |       refresh = RefreshOption.LOG | RefreshOption.THREADS
     |       cnx.cmd_refresh(refresh)
     |      
     |      The result is a dictionary with the OK packet information.
     |      
     |      Returns a dict()
     |  
     |  cmd_reset_connection(self)
     |      Resets the session state without re-authenticating
     |      
     |      Works only for MySQL server 5.7.3 or later.
     |      The result is a dictionary with OK packet information.
     |      
     |      Returns a dict()
     |  
     |  cmd_shutdown(self, shutdown_type=None)
     |      Shut down the MySQL Server
     |      
     |      This method sends the SHUTDOWN command to the MySQL server and is only
     |      possible if the current user has SUPER privileges. The result is a
     |      dictionary containing the OK packet information.
     |      
     |      Note: Most applications and scripts do not the SUPER privilege.
     |      
     |      Returns a dict()
     |  
     |  cmd_statistics(self)
     |      Send the statistics command to the MySQL Server
     |      
     |      This method sends the STATISTICS command to the MySQL server. The
     |      result is a dictionary with various statistical information.
     |      
     |      Returns a dict()
     |  
     |  cmd_stmt_close(self, statement_id)
     |      Deallocate a prepared MySQL statement
     |      
     |      This method deallocates the prepared statement using the
     |      statement_id. Note that the MySQL server does not return
     |      anything.
     |  
     |  cmd_stmt_execute(self, statement_id, data=(), parameters=(), flags=0)
     |      Execute a prepared MySQL statement
     |  
     |  cmd_stmt_fetch(self, statement_id, rows=1)
     |      Fetch a MySQL statement Result Set
     |      
     |      This method will send the FETCH command to MySQL together with the
     |      given statement id and the number of rows to fetch.
     |  
     |  cmd_stmt_prepare(self, statement)
     |      Prepare a MySQL statement
     |      
     |      This method will send the PREPARE command to MySQL together with the
     |      given statement.
     |      
     |      Returns a dict()
     |  
     |  cmd_stmt_reset(self, statement_id)
     |      Reset data for prepared statement sent as long data
     |      
     |      The result is a dictionary with OK packet information.
     |      
     |      Returns a dict()
     |  
     |  cmd_stmt_send_long_data(self, statement_id, param_id, data)
     |      Send data for a column
     |      
     |      This methods send data for a column (for example BLOB) for statement
     |      identified by statement_id. The param_id indicate which parameter
     |      the data belongs too.
     |      The data argument should be a file-like object.
     |      
     |      Since MySQL does not send anything back, no error is raised. When
     |      the MySQL server is not reachable, an OperationalError is raised.
     |      
     |      cmd_stmt_send_long_data should be called before cmd_stmt_execute.
     |      
     |      The total bytes send is returned.
     |      
     |      Returns int.
     |  
     |  commit(self)
     |      Commit current transaction
     |  
     |  consume_results(self)
     |      Consume results
     |  
     |  cursor(self, buffered=None, raw=None, prepared=None, cursor_class=None, dictionary=None, named_tuple=None)
     |      Instantiates and returns a cursor
     |      
     |      By default, MySQLCursor is returned. Depending on the options
     |      while connecting, a buffered and/or raw cursor is instantiated
     |      instead. Also depending upon the cursor options, rows can be
     |      returned as dictionary or named tuple.
     |      
     |      Dictionary and namedtuple based cursors are available with buffered
     |      output but not raw.
     |      
     |      It is possible to also give a custom cursor through the
     |      cursor_class parameter, but it needs to be a subclass of
     |      mysql.connector.cursor.CursorBase.
     |      
     |      Raises ProgrammingError when cursor_class is not a subclass of
     |      CursorBase. Raises ValueError when cursor is not available.
     |      
     |      Returns a cursor-object
     |  
     |  disconnect = close(self)
     |  
     |  get_row(self, binary=False, columns=None, raw=None)
     |      Get the next rows returned by the MySQL server
     |      
     |      This method gets one row from the result set after sending, for
     |      example, the query command. The result is a tuple consisting of the
     |      row and the EOF packet.
     |      If no row was available in the result set, the row data will be None.
     |      
     |      Returns a tuple.
     |  
     |  get_rows(self, count=None, binary=False, columns=None, raw=None)
     |      Get all rows returned by the MySQL server
     |      
     |      This method gets all rows returned by the MySQL server after sending,
     |      for example, the query command. The result is a tuple consisting of
     |      a list of rows and the EOF packet.
     |      
     |      Returns a tuple()
     |  
     |  handle_unread_result(self)
     |      Check whether there is an unread result
     |  
     |  info_query(self, query)
     |      Send a query which only returns 1 row
     |  
     |  is_connected(self)
     |      Reports whether the connection to MySQL Server is available
     |      
     |      This method checks whether the connection to MySQL is available.
     |      It is similar to ping(), but unlike the ping()-method, either True
     |      or False is returned and no exception is raised.
     |      
     |      Returns True or False.
     |  
     |  ping(self, reconnect=False, attempts=1, delay=0)
     |      Check availability of the MySQL server
     |      
     |      When reconnect is set to True, one or more attempts are made to try
     |      to reconnect to the MySQL server using the reconnect()-method.
     |      
     |      delay is the number of seconds to wait between each retry.
     |      
     |      When the connection is not available, an InterfaceError is raised. Use
     |      the is_connected()-method if you just want to check the connection
     |      without raising an error.
     |      
     |      Raises InterfaceError on errors.
     |  
     |  reconnect(self, attempts=1, delay=0)
     |      Attempt to reconnect to the MySQL server
     |      
     |      The argument attempts should be the number of times a reconnect
     |      is tried. The delay argument is the number of seconds to wait between
     |      each retry.
     |      
     |      You may want to set the number of attempts higher and use delay when
     |      you expect the MySQL server to be down for maintenance or when you
     |      expect the network to be temporary unavailable.
     |      
     |      Raises InterfaceError on errors.
     |  
     |  reset_session(self, user_variables=None, session_variables=None)
     |      Clears the current active session
     |      
     |      This method resets the session state, if the MySQL server is 5.7.3
     |      or later active session will be reset without re-authenticating.
     |      For other server versions session will be reset by re-authenticating.
     |      
     |      It is possible to provide a sequence of variables and their values to
     |      be set after clearing the session. This is possible for both user
     |      defined variables and session variables.
     |      This method takes two arguments user_variables and session_variables
     |      which are dictionaries.
     |      
     |      Raises OperationalError if not connected, InternalError if there are
     |      unread results and InterfaceError on errors.
     |  
     |  rollback(self)
     |      Rollback current transaction
     |  
     |  shutdown(self)
     |      Shut down connection to MySQL Server.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  connection_id
     |      MySQL connection ID
     |  
     |  database
     |      Get the current database
     |  
     |  in_transaction
     |      MySQL session has started a transaction
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |  
     |  __abstractmethods__ = frozenset()
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from mysql.connector.abstracts.MySQLConnectionAbstract:
     |  
     |  cmd_process_info(self)
     |      Get the process list of the MySQL Server
     |      
     |      This method is a placeholder to notify that the PROCESS_INFO command
     |      is not supported by raising the NotSupportedError. The command
     |      "SHOW PROCESSLIST" should be send using the cmd_query()-method or
     |      using the INFORMATION_SCHEMA database.
     |      
     |      Raises NotSupportedError exception
     |  
     |  config(self, **kwargs)
     |      Configure the MySQL Connection
     |      
     |      This method allows you to configure the MySQLConnection instance.
     |      
     |      Raises on errors.
     |  
     |  connect(self, **kwargs)
     |      Connect to the MySQL server
     |      
     |      This method sets up the connection to the MySQL server. If no
     |      arguments are given, it will use the already configured or default
     |      values.
     |  
     |  get_server_info(self)
     |      Get the original MySQL version information
     |      
     |      This method returns the original MySQL server as text. If not
     |      previously connected, it will return None.
     |      
     |      Returns a string or None.
     |  
     |  get_server_version(self)
     |      Get the MySQL version
     |      
     |      This method returns the MySQL server version as a tuple. If not
     |      previously connected, it will return None.
     |      
     |      Returns a tuple or None.
     |  
     |  isset_client_flag(self, flag)
     |      Check if a client flag is set
     |  
     |  set_charset_collation(self, charset=None, collation=None)
     |      Sets the character set and collation for the current connection
     |      
     |      This method sets the character set and collation to be used for
     |      the current connection. The charset argument can be either the
     |      name of a character set as a string, or the numerical equivalent
     |      as defined in constants.CharacterSet.
     |      
     |      When the collation is not given, the default will be looked up and
     |      used.
     |      
     |      For example, the following will set the collation for the latin1
     |      character set to latin1_general_ci:
     |      
     |         set_charset('latin1','latin1_general_ci')
     |  
     |  set_client_flags(self, flags)
     |      Set the client flags
     |      
     |      The flags-argument can be either an int or a list (or tuple) of
     |      ClientFlag-values. If it is an integer, it will set client_flags
     |      to flags as is.
     |      If flags is a list (or tuple), each flag will be set or unset
     |      when it's negative.
     |      
     |      set_client_flags([ClientFlag.FOUND_ROWS,-ClientFlag.LONG_FLAG])
     |      
     |      Raises ProgrammingError when the flags argument is not a set or
     |      an integer bigger than 0.
     |      
     |      Returns self.client_flags
     |  
     |  set_converter_class(self, convclass)
     |      Set the converter class to be used. This should be a class overloading
     |      methods and members of conversion.MySQLConverter.
     |  
     |  set_login(self, username=None, password=None)
     |      Set login information for MySQL
     |      
     |      Set the username and/or password for the user connecting to
     |      the MySQL Server.
     |  
     |  set_unicode(self, value=True)
     |      Toggle unicode mode
     |      
     |      Set whether we return string fields as unicode or not.
     |      Default is True.
     |  
     |  start_transaction(self, consistent_snapshot=False, isolation_level=None, readonly=None)
     |      Start a transaction
     |      
     |      This method explicitly starts a transaction sending the
     |      START TRANSACTION statement to the MySQL server. You can optionally
     |      set whether there should be a consistent snapshot, which
     |      isolation level you need or which access mode i.e. READ ONLY or
     |      READ WRITE.
     |      
     |      For example, to start a transaction with isolation level SERIALIZABLE,
     |      you would do the following:
     |          >>> cnx = mysql.connector.connect(..)
     |          >>> cnx.start_transaction(isolation_level='SERIALIZABLE')
     |      
     |      Raises ProgrammingError when a transaction is already in progress
     |      and when ValueError when isolation_level specifies an Unknown
     |      level.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from mysql.connector.abstracts.MySQLConnectionAbstract:
     |  
     |  autocommit
     |      Get whether autocommit is on or off
     |  
     |  can_consume_results
     |      Returns whether to consume results
     |  
     |  charset
     |      Returns the character set for current connection
     |      
     |      This property returns the character set name of the current connection.
     |      The server is queried when the connection is active. If not connected,
     |      the configured character set name is returned.
     |      
     |      Returns a string.
     |  
     |  collation
     |      Returns the collation for current connection
     |      
     |      This property returns the collation name of the current connection.
     |      The server is queried when the connection is active. If not connected,
     |      the configured collation name is returned.
     |      
     |      Returns a string.
     |  
     |  get_warnings
     |      Get whether this connection retrieves warnings automatically
     |      
     |      This method returns whether this connection retrieves warnings
     |      automatically.
     |      
     |      Returns True, or False when warnings are not retrieved.
     |  
     |  python_charset
     |      Returns the Python character set for current connection
     |      
     |      This property returns the character set name of the current connection.
     |      Note that, unlike property charset, this checks if the previously set
     |      character set is supported by Python and if not, it returns the
     |      equivalent character set that Python supports.
     |      
     |      Returns a string.
     |  
     |  raise_on_warnings
     |      Get whether this connection raises an error on warnings
     |      
     |      This method returns whether this connection will raise errors when
     |      MySQL reports warnings.
     |      
     |      Returns True or False.
     |  
     |  server_host
     |      MySQL server IP address or name
     |  
     |  server_port
     |      MySQL server TCP/IP port
     |  
     |  sql_mode
     |      Get the SQL mode
     |  
     |  time_zone
     |      Get the current time zone
     |  
     |  unix_socket
     |      MySQL Unix socket file location
     |  
     |  unread_result
     |      Get whether there is an unread result
     |      
     |      This method is used by cursors to check whether another cursor still
     |      needs to retrieve its result set.
     |      
     |      Returns True, or False when there is no unread result.
     |  
     |  user
     |      User used while connecting to MySQL
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from mysql.connector.abstracts.MySQLConnectionAbstract:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
    
    class NotSupportedError(DatabaseError)
     |  NotSupportedError(msg=None, errno=None, values=None, sqlstate=None)
     |  
     |  Exception for errors when an unsupported database feature was used
     |  
     |  Method resolution order:
     |      NotSupportedError
     |      DatabaseError
     |      Error
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |  
     |  Methods inherited from Error:
     |  
     |  __init__(self, msg=None, errno=None, values=None, sqlstate=None)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  __str__(self)
     |      Return str(self).
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from Error:
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.Exception:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |  
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |  
     |  __setstate__(...)
     |  
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |  
     |  __cause__
     |      exception cause
     |  
     |  __context__
     |      exception context
     |  
     |  __dict__
     |  
     |  __suppress_context__
     |  
     |  __traceback__
     |  
     |  args
    
    class OperationalError(DatabaseError)
     |  OperationalError(msg=None, errno=None, values=None, sqlstate=None)
     |  
     |  Exception for errors related to the database's operation
     |  
     |  Method resolution order:
     |      OperationalError
     |      DatabaseError
     |      Error
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |  
     |  Methods inherited from Error:
     |  
     |  __init__(self, msg=None, errno=None, values=None, sqlstate=None)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  __str__(self)
     |      Return str(self).
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from Error:
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.Exception:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |  
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |  
     |  __setstate__(...)
     |  
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |  
     |  __cause__
     |      exception cause
     |  
     |  __context__
     |      exception context
     |  
     |  __dict__
     |  
     |  __suppress_context__
     |  
     |  __traceback__
     |  
     |  args
    
    class ProgrammingError(DatabaseError)
     |  ProgrammingError(msg=None, errno=None, values=None, sqlstate=None)
     |  
     |  Exception for errors programming errors
     |  
     |  Method resolution order:
     |      ProgrammingError
     |      DatabaseError
     |      Error
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |  
     |  Methods inherited from Error:
     |  
     |  __init__(self, msg=None, errno=None, values=None, sqlstate=None)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  __str__(self)
     |      Return str(self).
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from Error:
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.Exception:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |  
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |  
     |  __setstate__(...)
     |  
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |  
     |  __cause__
     |      exception cause
     |  
     |  __context__
     |      exception context
     |  
     |  __dict__
     |  
     |  __suppress_context__
     |  
     |  __traceback__
     |  
     |  args
    
    class RefreshOption(_Constants)
     |  MySQL Refresh command options
     |  
     |  Options used when sending the COM_REFRESH server command.
     |  
     |  Method resolution order:
     |      RefreshOption
     |      _Constants
     |      builtins.object
     |  
     |  Data and other attributes defined here:
     |  
     |  GRANT = 1
     |  
     |  HOST = 8
     |  
     |  LOG = 2
     |  
     |  SLAVE = 64
     |  
     |  STATUS = 16
     |  
     |  TABLES = 4
     |  
     |  THREADS = 32
     |  
     |  desc = {'GRANT': (1, 'Refresh grant tables'), 'HOSTS': (8, 'Flush host...
     |  
     |  ----------------------------------------------------------------------
     |  Class methods inherited from _Constants:
     |  
     |  get_desc(name) from builtins.type
     |      Get description of given constant
     |  
     |  get_full_info() from builtins.type
     |      get full information about given constant
     |  
     |  get_info(setid) from builtins.type
     |      Get information about given constant
     |  
     |  ----------------------------------------------------------------------
     |  Static methods inherited from _Constants:
     |  
     |  __new__(cls)
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from _Constants:
     |  
     |  __dict__
     |      dictionary for instance variables (if defined)
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes inherited from _Constants:
     |  
     |  prefix = ''
    
    Time = class time(builtins.object)
     |  time([hour[, minute[, second[, microsecond[, tzinfo]]]]]) --> a time object
     |  
     |  All arguments are optional. tzinfo may be None, or an instance of
     |  a tzinfo subclass. The remaining arguments may be ints.
     |  
     |  Methods defined here:
     |  
     |  __eq__(self, value, /)
     |      Return self==value.
     |  
     |  __format__(...)
     |      Formats self with strftime.
     |  
     |  __ge__(self, value, /)
     |      Return self>=value.
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __gt__(self, value, /)
     |      Return self>value.
     |  
     |  __hash__(self, /)
     |      Return hash(self).
     |  
     |  __le__(self, value, /)
     |      Return self<=value.
     |  
     |  __lt__(self, value, /)
     |      Return self<value.
     |  
     |  __ne__(self, value, /)
     |      Return self!=value.
     |  
     |  __reduce__(...)
     |      __reduce__() -> (cls, state)
     |  
     |  __reduce_ex__(...)
     |      __reduce_ex__(proto) -> (cls, state)
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  __str__(self, /)
     |      Return str(self).
     |  
     |  dst(...)
     |      Return self.tzinfo.dst(self).
     |  
     |  isoformat(...)
     |      Return string in ISO 8601 format, [HH[:MM[:SS[.mmm[uuu]]]]][+HH:MM].
     |      
     |      timespec specifies what components of the time to include.
     |  
     |  replace(...)
     |      Return time with new specified fields.
     |  
     |  strftime(...)
     |      format -> strftime() style string.
     |  
     |  tzname(...)
     |      Return self.tzinfo.tzname(self).
     |  
     |  utcoffset(...)
     |      Return self.tzinfo.utcoffset(self).
     |  
     |  ----------------------------------------------------------------------
     |  Class methods defined here:
     |  
     |  fromisoformat(...) from builtins.type
     |      string -> time from time.isoformat() output
     |  
     |  ----------------------------------------------------------------------
     |  Static methods defined here:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  fold
     |  
     |  hour
     |  
     |  microsecond
     |  
     |  minute
     |  
     |  second
     |  
     |  tzinfo
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |  
     |  max = datetime.time(23, 59, 59, 999999)
     |  
     |  min = datetime.time(0, 0)
     |  
     |  resolution = datetime.timedelta(microseconds=1)
    
    Timestamp = class datetime(date)
     |  datetime(year, month, day[, hour[, minute[, second[, microsecond[,tzinfo]]]]])
     |  
     |  The year, month and day arguments are required. tzinfo may be None, or an
     |  instance of a tzinfo subclass. The remaining arguments may be ints.
     |  
     |  Method resolution order:
     |      datetime
     |      date
     |      builtins.object
     |  
     |  Methods defined here:
     |  
     |  __add__(self, value, /)
     |      Return self+value.
     |  
     |  __eq__(self, value, /)
     |      Return self==value.
     |  
     |  __ge__(self, value, /)
     |      Return self>=value.
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __gt__(self, value, /)
     |      Return self>value.
     |  
     |  __hash__(self, /)
     |      Return hash(self).
     |  
     |  __le__(self, value, /)
     |      Return self<=value.
     |  
     |  __lt__(self, value, /)
     |      Return self<value.
     |  
     |  __ne__(self, value, /)
     |      Return self!=value.
     |  
     |  __radd__(self, value, /)
     |      Return value+self.
     |  
     |  __reduce__(...)
     |      __reduce__() -> (cls, state)
     |  
     |  __reduce_ex__(...)
     |      __reduce_ex__(proto) -> (cls, state)
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  __rsub__(self, value, /)
     |      Return value-self.
     |  
     |  __str__(self, /)
     |      Return str(self).
     |  
     |  __sub__(self, value, /)
     |      Return self-value.
     |  
     |  astimezone(...)
     |      tz -> convert to local time in new timezone tz
     |  
     |  ctime(...)
     |      Return ctime() style string.
     |  
     |  date(...)
     |      Return date object with same year, month and day.
     |  
     |  dst(...)
     |      Return self.tzinfo.dst(self).
     |  
     |  isoformat(...)
     |      [sep] -> string in ISO 8601 format, YYYY-MM-DDT[HH[:MM[:SS[.mmm[uuu]]]]][+HH:MM].
     |      sep is used to separate the year from the time, and defaults to 'T'.
     |      timespec specifies what components of the time to include (allowed values are 'auto', 'hours', 'minutes', 'seconds', 'milliseconds', and 'microseconds').
     |  
     |  replace(...)
     |      Return datetime with new specified fields.
     |  
     |  time(...)
     |      Return time object with same time but with tzinfo=None.
     |  
     |  timestamp(...)
     |      Return POSIX timestamp as float.
     |  
     |  timetuple(...)
     |      Return time tuple, compatible with time.localtime().
     |  
     |  timetz(...)
     |      Return time object with same time and tzinfo.
     |  
     |  tzname(...)
     |      Return self.tzinfo.tzname(self).
     |  
     |  utcoffset(...)
     |      Return self.tzinfo.utcoffset(self).
     |  
     |  utctimetuple(...)
     |      Return UTC time tuple, compatible with time.localtime().
     |  
     |  ----------------------------------------------------------------------
     |  Class methods defined here:
     |  
     |  combine(...) from builtins.type
     |      date, time -> datetime with same date and time fields
     |  
     |  fromisoformat(...) from builtins.type
     |      string -> datetime from datetime.isoformat() output
     |  
     |  fromtimestamp(...) from builtins.type
     |      timestamp[, tz] -> tz's local time from POSIX timestamp.
     |  
     |  now(tz=None) from builtins.type
     |      Returns new datetime object representing current time local to tz.
     |      
     |        tz
     |          Timezone object.
     |      
     |      If no tz is specified, uses local timezone.
     |  
     |  strptime(...) from builtins.type
     |      string, format -> new datetime parsed from a string (like time.strptime()).
     |  
     |  utcfromtimestamp(...) from builtins.type
     |      Construct a naive UTC datetime from a POSIX timestamp.
     |  
     |  utcnow(...) from builtins.type
     |      Return a new datetime representing UTC day and time.
     |  
     |  ----------------------------------------------------------------------
     |  Static methods defined here:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors defined here:
     |  
     |  fold
     |  
     |  hour
     |  
     |  microsecond
     |  
     |  minute
     |  
     |  second
     |  
     |  tzinfo
     |  
     |  ----------------------------------------------------------------------
     |  Data and other attributes defined here:
     |  
     |  max = datetime.datetime(9999, 12, 31, 23, 59, 59, 999999)
     |  
     |  min = datetime.datetime(1, 1, 1, 0, 0)
     |  
     |  resolution = datetime.timedelta(microseconds=1)
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from date:
     |  
     |  __format__(...)
     |      Formats self with strftime.
     |  
     |  isocalendar(...)
     |      Return a 3-tuple containing ISO year, week number, and weekday.
     |  
     |  isoweekday(...)
     |      Return the day of the week represented by the date.
     |      Monday == 1 ... Sunday == 7
     |  
     |  strftime(...)
     |      format -> strftime() style string.
     |  
     |  toordinal(...)
     |      Return proleptic Gregorian ordinal.  January 1 of year 1 is day 1.
     |  
     |  weekday(...)
     |      Return the day of the week represented by the date.
     |      Monday == 0 ... Sunday == 6
     |  
     |  ----------------------------------------------------------------------
     |  Class methods inherited from date:
     |  
     |  fromordinal(...) from builtins.type
     |      int -> date corresponding to a proleptic Gregorian ordinal.
     |  
     |  today(...) from builtins.type
     |      Current date or datetime:  same as self.__class__.fromtimestamp(time.time()).
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from date:
     |  
     |  day
     |  
     |  month
     |  
     |  year
    
    class Warning(builtins.Exception)
     |  Exception for important warnings
     |  
     |  Method resolution order:
     |      Warning
     |      builtins.Exception
     |      builtins.BaseException
     |      builtins.object
     |  
     |  Data descriptors defined here:
     |  
     |  __weakref__
     |      list of weak references to the object (if defined)
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.Exception:
     |  
     |  __init__(self, /, *args, **kwargs)
     |      Initialize self.  See help(type(self)) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Static methods inherited from builtins.Exception:
     |  
     |  __new__(*args, **kwargs) from builtins.type
     |      Create and return a new object.  See help(type) for accurate signature.
     |  
     |  ----------------------------------------------------------------------
     |  Methods inherited from builtins.BaseException:
     |  
     |  __delattr__(self, name, /)
     |      Implement delattr(self, name).
     |  
     |  __getattribute__(self, name, /)
     |      Return getattr(self, name).
     |  
     |  __reduce__(...)
     |      Helper for pickle.
     |  
     |  __repr__(self, /)
     |      Return repr(self).
     |  
     |  __setattr__(self, name, value, /)
     |      Implement setattr(self, name, value).
     |  
     |  __setstate__(...)
     |  
     |  __str__(self, /)
     |      Return str(self).
     |  
     |  with_traceback(...)
     |      Exception.with_traceback(tb) --
     |      set self.__traceback__ to tb and return self.
     |  
     |  ----------------------------------------------------------------------
     |  Data descriptors inherited from builtins.BaseException:
     |  
     |  __cause__
     |      exception cause
     |  
     |  __context__
     |      exception context
     |  
     |  __dict__
     |  
     |  __suppress_context__
     |  
     |  __traceback__
     |  
     |  args

## FUNCTIONS
    Connect = connect(*args, **kwargs)
        Create or get a MySQL connection object
        
        In its simpliest form, Connect() will open a connection to a
        MySQL server and return a MySQLConnection object.
        
        When any connection pooling arguments are given, for example pool_name
        or pool_size, a pool is created or a previously one is used to return
        a PooledMySQLConnection.
        
        Returns MySQLConnection or PooledMySQLConnection.
    
    DateFromTicks(ticks)
    
    TimeFromTicks(ticks)
    
    TimestampFromTicks(ticks)
    
    connect(*args, **kwargs)
        Create or get a MySQL connection object
        
        In its simpliest form, Connect() will open a connection to a
        MySQL server and return a MySQLConnection object.
        
        When any connection pooling arguments are given, for example pool_name
        or pool_size, a pool is created or a previously one is used to return
        a PooledMySQLConnection.
        
        Returns MySQLConnection or PooledMySQLConnection.
    
    custom_error_exception(error=None, exception=None)
        Define custom exceptions for MySQL server errors
        
        This function defines custom exceptions for MySQL server errors and
        returns the current set customizations.
        
        If error is a MySQL Server error number, then you have to pass also the
        exception class.
        
        The error argument can also be a dictionary in which case the key is
        the server error number, and value the exception to be raised.
        
        If none of the arguments are given, then custom_error_exception() will
        simply return the current set customizations.
        
        To reset the customizations, simply supply an empty dictionary.
        
        Examples:
            import mysql.connector
            from mysql.connector import errorcode
        
            # Server error 1028 should raise a DatabaseError
            mysql.connector.custom_error_exception(
                1028, mysql.connector.DatabaseError)
        
            # Or using a dictionary:
            mysql.connector.custom_error_exception({
                1028: mysql.connector.DatabaseError,
                1029: mysql.connector.OperationalError,
                })
        
            # Reset
            mysql.connector.custom_error_exception({})
        
        Returns a dictionary.

DATA

1
2
3
4
5
6
7
8
9
10
11
BINARY = <mysql.connector.dbapi._DBAPITypeObject object>
DATETIME = <mysql.connector.dbapi._DBAPITypeObject object>
HAVE_CEXT = True
NUMBER = <mysql.connector.dbapi._DBAPITypeObject object>
ROWID = <mysql.connector.dbapi._DBAPITypeObject object>
STRING = <mysql.connector.dbapi._DBAPITypeObject object>
__all__ = ['MySQLConnection', 'Connect', 'custom_error_exception', 'Fi...
__version_info__ = (8, 0, 16, '', 1)
apilevel = '2.0'
paramstyle = 'pyformat'
threadsafety = 1

VERSION

1
8.0.16

FILE

1
/home/shelling/env/lib/python3.7/site-packages/mysql/connector/__init__.py

Help on class Redis in module redis.client 

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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
'''Help on class Redis in module redis.client:'''

class Redis(builtins.object)
    Redis(
    	host='localhost', port=6379, db=0, password=None, socket_timeout=None, 
    	socket_connect_timeout=None, socket_keepalive=None, 
    	socket_keepalive_options=None, connection_pool=None, 
    	unix_socket_path=None, encoding='utf-8', encoding_errors='strict', 
    	charset=None, errors=None, decode_responses=False, 
    	retry_on_timeout=False, ssl=False, ssl_keyfile=None, ssl_certfile=None, 
    	ssl_cert_reqs='required', ssl_ca_certs=None, max_connections=None
    )
    
    '''
    Implementation of the Redis protocol.
    
    This abstract class provides a Python interface to all Redis commands
    and an implementation of the Redis protocol.
    
    Connection and Pipeline derive from this, implementing how
    the commands are sent and received to the Redis server
    
    Methods defined here:
    '''
    __contains__ = exists(self, *names)
    
    __delitem__(self, name)
    
    __getitem__(self, name)
        '''Return the value at key ``name``, raises a KeyError if the key
        doesn't exist.'''
    
    __init__(self, host='localhost', port=6379, db=0, password=None, socket_timeout=None, socket_connect_timeout=None, socket_keepalive=None, socket_keepalive_options=None, connection_pool=None, unix_socket_path=None, encoding='utf-8', encoding_errors='strict', charset=None, errors=None, decode_responses=False, retry_on_timeout=False, ssl=False, ssl_keyfile=None, ssl_certfile=None, ssl_cert_reqs='required', ssl_ca_certs=None, max_connections=None)
        '''Initialize self.  See help(type(self)) for accurate signature.'''
    
    __repr__(self)
    	'''Return repr(self).'''
    
    __setitem__(self, name, value)
    
    append(self, key, value)
        '''
        Appends the string ``value`` to the value at ``key``. If ``key``
        doesn't already exist, create it with a value of ``value``.
        Returns the new length of the value at ``key``.
    	'''

    bgrewriteaof(self)
    	'''
        Tell the Redis server to rewrite the AOF file from data in memory.
    	'''

    bgsave(self)
        '''
        Tell the Redis server to save its data to disk.  Unlike save(),
        this method is asynchronous and returns immediately.
    	'''

    bitcount(self, key, start=None, end=None)
        '''
        Returns the count of set bits in the value of ``key``.  Optional
        ``start`` and ``end`` paramaters indicate which bytes to consider
    	'''

    bitfield(self, key, default_overflow=None)
        '''
        Return a BitFieldOperation instance to conveniently construct one or
        more bitfield operations on ``key``.
    	'''

    bitop(self, operation, dest, *keys)
        '''
        Perform a bitwise operation using ``operation`` between ``keys`` and
        store the result in ``dest``.
    	'''

    bitpos(self, key, bit, start=None, end=None)
        '''
        Return the position of the first bit set to 1 or 0 in a string.
        ``start`` and ``end`` difines search range. The range is interpreted
        as a range of bytes and not a range of bits, so start=0 and end=2
        means to look at the first three bytes.
    	'''

    blpop(self, keys, timeout=0)
        '''
        LPOP a value off of the first non-empty list
        named in the ``keys`` list.
        
        If none of the lists in ``keys`` has a value to LPOP, then block
        for ``timeout`` seconds, or until a value gets pushed on to one
        of the lists.
        
        If timeout is 0, then block indefinitely.
    	'''

    brpop(self, keys, timeout=0)
    	'''
        RPOP a value off of the first non-empty list
        named in the ``keys`` list.
        
        If none of the lists in ``keys`` has a value to RPOP, then block
        for ``timeout`` seconds, or until a value gets pushed on to one
        of the lists.
        
        If timeout is 0, then block indefinitely.
        '''
    
    brpoplpush(self, src, dst, timeout=0)
        '''
        Pop a value off the tail of ``src``, push it on the head of ``dst``
        and then return it.
        
        This command blocks until a value is in ``src`` or until ``timeout``
        seconds elapse, whichever is first. A ``timeout`` value of 0 blocks
        forever.
    	'''

    bzpopmax(self, keys, timeout=0)
        '''
        ZPOPMAX a value off of the first non-empty sorted set
        named in the ``keys`` list.
        
        If none of the sorted sets in ``keys`` has a value to ZPOPMAX,
        then block for ``timeout`` seconds, or until a member gets added
        to one of the sorted sets.
        
        If timeout is 0, then block indefinitely.
    	'''

    bzpopmin(self, keys, timeout=0)
        '''
        ZPOPMIN a value off of the first non-empty sorted set
        named in the ``keys`` list.
        
        If none of the sorted sets in ``keys`` has a value to ZPOPMIN,
        then block for ``timeout`` seconds, or until a member gets added
        to one of the sorted sets.
        
        If timeout is 0, then block indefinitely.
    	'''

    client_getname(self)
        '''Returns the current connection name'''
    
    client_id(self)
        '''Returns the current connection id'''
    
    client_kill(self, address)
        '''Disconnects the client at ``address`` (ip:port)'''
    
    client_kill_filter(self, _id=None, _type=None, addr=None, skipme=None)
        '''
        Disconnects client(s) using a variety of filter options
        :param id: Kills a client by its unique ID field
        :param type: Kills a client by type where type is one of 'normal',
        'master', 'slave' or 'pubsub'
        :param addr: Kills a client by its 'address:port'
        :param skipme: If True, then the client calling the command
        will not get killed even if it is identified by one of the filter
        options. If skipme is not provided, the server defaults to skipme=True
    	'''

    client_list(self, _type=None)
        '''
        Returns a list of currently connected clients.
        If type of client specified, only that type will be returned.
        :param _type: optional. one of the client types (normal, master,
         replica, pubsub)
    	'''

    client_pause(self, timeout)
        '''
        Suspend all the Redis clients for the specified amount of time
        :param timeout: milliseconds to pause clients
    	'''

    client_setname(self, name)
        '''Sets the current connection name'''
    
    client_unblock(self, client_id, error=False)
        '''
        Unblocks a connection by its client id.
        If ``error`` is True, unblocks the client with a special error message.
        If ``error`` is False (default), the client is unblocked using the
        regular timeout mechanism.
        '''
    
    cluster(self, cluster_arg, *args)
    
    config_get(self, pattern='*')
        '''Return a dictionary of configuration based on the ``pattern``'''
    
    config_resetstat(self)
        '''Reset runtime statistics'''
    
    config_rewrite(self)
        '''Rewrite config file with the minimal change to reflect running config'''
    
    config_set(self, name, value)
        '''Set config item ``name`` with ``value``'''
    
    dbsize(self)
        '''Returns the number of keys in the current database'''
    
    debug_object(self, key)
        '''Returns version specific meta information about a given key'''
    
    decr(self, name, amount=1)
        '''
        Decrements the value of ``key`` by ``amount``.  If no key exists,
        the value will be initialized as 0 - ``amount``
    	'''

    decrby(self, name, amount=1)
        '''
        Decrements the value of ``key`` by ``amount``.  If no key exists,
        the value will be initialized as 0 - ``amount``
    	'''

    delete(self, *names)
        '''Delete one or more keys specified by ``names``'''
    
    dump(self, name)
        '''
        Return a serialized version of the value stored at the specified key.
        If key does not exist a nil bulk reply is returned.
    	'''

    echo(self, value)
        '''Echo the string back from the server'''
    
    eval(self, script, numkeys, *keys_and_args)
        '''
        Execute the Lua ``script``, specifying the ``numkeys`` the script
        will touch and the key names and argument values in ``keys_and_args``.
        Returns the result of the script.
        
        In practice, use the object returned by ``register_script``. This
        function exists purely for Redis API completion.
    	'''

    evalsha(self, sha, numkeys, *keys_and_args)
        '''
        Use the ``sha`` to execute a Lua script already registered via EVAL
        or SCRIPT LOAD. Specify the ``numkeys`` the script will touch and the
        key names and argument values in ``keys_and_args``. Returns the result
        of the script.
        
        In practice, use the object returned by ``register_script``. This
        function exists purely for Redis API completion.
    	'''

    execute_command(self, *args, **options)
        '''Execute a command and return a parsed response'''
    
    exists(self, *names)
       ''' Returns the number of ``names`` that exist'''
    
    expire(self, name, time)
        '''
        Set an expire flag on key ``name`` for ``time`` seconds. ``time``
        can be represented by an integer or a Python timedelta object.
    	'''

    expireat(self, name, when)
        '''
        Set an expire flag on key ``name``. ``when`` can be represented
        as an integer indicating unix time or a Python datetime object.
    	'''

    flushall(self, asynchronous=False)
        '''
        Delete all keys in all databases on the current host.
        
        ``asynchronous`` indicates whether the operation is
        executed asynchronously by the server.
    	'''

    flushdb(self, asynchronous=False)
    	'''
        Delete all keys in the current database.
        
        ``asynchronous`` indicates whether the operation is
        executed asynchronously by the server.
    	'''

    geoadd(self, name, *values)
        '''
        Add the specified geospatial items to the specified key identified
        by the ``name`` argument. The Geospatial items are given as ordered
        members of the ``values`` argument, each item or place is formed by
        the triad longitude, latitude and name.
    	'''

    geodist(self, name, place1, place2, unit=None)
        '''
        Return the distance between ``place1`` and ``place2`` members of the
        ``name`` key.
        The units must be one of the following : m, km mi, ft. By default
        meters are used.
    	'''

    geohash(self, name, *values)
        '''
        Return the geo hash string for each item of ``values`` members of
        the specified key identified by the ``name`` argument.
    	'''

    geopos(self, name, *values)
        '''
        Return the positions of each item of ``values`` as members of
        the specified key identified by the ``name`` argument. Each position
        is represented by the pairs lon and lat.
    	'''

    georadius(self, name, longitude, latitude, radius, unit=None, withdist=False, withcoord=False, withhash=False, count=None, sort=None, store=None, store_dist=None)
        '''
        Return the members of the specified key identified by the
        ``name`` argument which are within the borders of the area specified
        with the ``latitude`` and ``longitude`` location and the maximum
        distance from the center specified by the ``radius`` value.
        
        The units must be one of the following : m, km mi, ft. By default
        
        ``withdist`` indicates to return the distances of each place.
        
        ``withcoord`` indicates to return the latitude and longitude of
        each place.
        
        ``withhash`` indicates to return the geohash string of each place.
        
        ``count`` indicates to return the number of elements up to N.
        
        ``sort`` indicates to return the places in a sorted way, ASC for
        nearest to fairest and DESC for fairest to nearest.
        
        ``store`` indicates to save the places names in a sorted set named
        with a specific key, each element of the destination sorted set is
        populated with the score got from the original geo sorted set.
        
        ``store_dist`` indicates to save the places names in a sorted set
        named with a specific key, instead of ``store`` the sorted set
        destination score is set with the distance.
    	'''

    georadiusbymember(self, name, member, radius, unit=None, withdist=False, withcoord=False, withhash=False, count=None, sort=None, store=None, store_dist=None)
        '''
        This command is exactly like ``georadius`` with the sole difference
        that instead of taking, as the center of the area to query, a longitude
        and latitude value, it takes the name of a member already existing
        inside the geospatial index represented by the sorted set.
    	'''

    get(self, name)
        '''Return the value at key ``name``, or None if the key doesn't exist'''
    
    getbit(self, name, offset)
        '''Returns a boolean indicating the value of ``offset`` in ``name``'''
    
    getrange(self, key, start, end)
        '''
        Returns the substring of the string value stored at ``key``,
        determined by the offsets ``start`` and ``end`` (both are inclusive)
    	'''

    getset(self, name, value)
        '''
        Sets the value at key ``name`` to ``value``
        and returns the old value at key ``name`` atomically.
    	'''

    hdel(self, name, *keys)
        '''Delete ``keys`` from hash ``name``'''
    
    hexists(self, name, key)
        '''Returns a boolean indicating if ``key`` exists within hash ``name``'''
    
    hget(self, name, key)
        '''Return the value of ``key`` within the hash ``name``'''
    
    hgetall(self, name)
        '''Return a Python dict of the hash's name/value pairs'''
    
    hincrby(self, name, key, amount=1)
        '''Increment the value of ``key`` in hash ``name`` by ``amount``'''
    
    hincrbyfloat(self, name, key, amount=1.0)
        '''Increment the value of ``key`` in hash ``name`` by floating ``amount``'''
    
    hkeys(self, name)
        '''Return the list of keys within hash ``name``'''
    
    hlen(self, name)
        '''Return the number of elements in hash ``name``'''
    
    hmget(self, name, keys, *args)
        '''Returns a list of values ordered identically to ``keys``'''
    
    hmset(self, name, mapping)
        ''' 
        Set key to value within hash ``name`` for each corresponding
        key and value from the ``mapping`` dict.
        '''
    
    hscan(self, name, cursor=0, match=None, count=None)
        '''
        Incrementally return key/value slices in a hash. Also return a cursor
        indicating the scan position.
        
        ``match`` allows for filtering the keys by pattern
        
        ``count`` allows for hint the minimum number of returns
        '''
    
    hscan_iter(self, name, match=None, count=None)
        '''
        Make an iterator using the HSCAN command so that the client doesn't
        need to remember the cursor position.
        
        ``match`` allows for filtering the keys by pattern
        
        ``count`` allows for hint the minimum number of returns
    	'''

    hset(self, name, key, value)
    	'''
        Set ``key`` to ``value`` within hash ``name``
        Returns 1 if HSET created a new field, otherwise 0
    	'''

    hsetnx(self, name, key, value)
    	'''
        Set ``key`` to ``value`` within hash ``name`` if ``key`` does not
        exist.  Returns 1 if HSETNX created a field, otherwise 0.
    	'''

    hstrlen(self, name, key)
        '''
        Return the number of bytes stored in the value of ``key``
        within hash ``name``
    	'''

    hvals(self, name)
        '''Return the list of values within hash ``name``'''
    
    incr(self, name, amount=1)
        '''
        Increments the value of ``key`` by ``amount``.  If no key exists,
        the value will be initialized as ``amount``
    	'''

    incrby(self, name, amount=1)
        '''
        Increments the value of ``key`` by ``amount``.  If no key exists,
        the value will be initialized as ``amount``
    	'''

    incrbyfloat(self, name, amount=1.0)
        '''
        Increments the value at key ``name`` by floating ``amount``.
        If no key exists, the value will be initialized as ``amount``
    	'''

    info(self, section=None)
        '''
        Returns a dictionary containing information about the Redis server
        
        The ``section`` option can be used to select a specific section
        of information
        
        The section option is not supported by older versions of Redis Server,
        and will generate ResponseError
    	'''

    keys(self, pattern='*')
        '''Returns a list of keys matching ``pattern``'''
    
    lastsave(self)
        '''
        Return a Python datetime object representing the last time the
        Redis database was saved to disk
        '''
    
    lindex(self, name, index)
    	'''
        Return the item from list ``name`` at position ``index``
        
        Negative indexes are supported and will return an item at the
        end of the list
        '''
    
    linsert(self, name, where, refvalue, value)
    	'''
        Insert ``value`` in list ``name`` either immediately before or after
        [``where``] ``refvalue``
        
        Returns the new length of the list on success or -1 if ``refvalue``
        is not in the list.
        '''
    
    llen(self, name)
        '''Return the length of the list ``name``'''
    
    lock(self, name, timeout=None, sleep=0.1, blocking_timeout=None, lock_class=None, thread_local=True)
        '''
        Return a new Lock object using key ``name`` that mimics
        the behavior of threading.Lock.
        
        If specified, ``timeout`` indicates a maximum life for the lock.
        By default, it will remain locked until release() is called.
        
        ``sleep`` indicates the amount of time to sleep per loop iteration
        when the lock is in blocking mode and another client is currently
        holding the lock.
        
        ``blocking_timeout`` indicates the maximum amount of time in seconds to
        spend trying to acquire the lock. A value of ``None`` indicates
        continue trying forever. ``blocking_timeout`` can be specified as a
        float or integer, both representing the number of seconds to wait.
        
        ``lock_class`` forces the specified lock implementation.
        
        ``thread_local`` indicates whether the lock token is placed in
        thread-local storage. By default, the token is placed in thread local
        storage so that a thread only sees its token, not a token set by
        another thread. Consider the following timeline:
        
            time: 0, thread-1 acquires `my-lock`, with a timeout of 5 seconds.
                     thread-1 sets the token to "abc"
            time: 1, thread-2 blocks trying to acquire `my-lock` using the
                     Lock instance.
            time: 5, thread-1 has not yet completed. redis expires the lock
                     key.
            time: 5, thread-2 acquired `my-lock` now that it's available.
                     thread-2 sets the token to "xyz"
            time: 6, thread-1 finishes its work and calls release(). if the
                     token is *not* stored in thread local storage, then
                     thread-1 would see the token value as "xyz" and would be
                     able to successfully release the thread-2's lock.
        
        In some use cases it's necessary to disable thread local storage. For
        example, if you have code where one thread acquires a lock and passes
        that lock instance to a worker thread to release later. If thread
        local storage isn't disabled in this case, the worker thread won't see
        the token set by the thread that acquired the lock. Our assumption
        is that these cases aren't common and as such default to using
        thread local storage.
    	'''

    lpop(self, name)
        '''Remove and return the first item of the list ``name``'''
    
    lpush(self, name, *values)
        '''Push ``values`` onto the head of the list ``name``'''
    
    lpushx(self, name, value)
        '''Push ``value`` onto the head of the list ``name`` if ``name`` exists'''
    
    lrange(self, name, start, end)
        '''
        Return a slice of the list ``name`` between
        position ``start`` and ``end``
        
        ``start`` and ``end`` can be negative numbers just like
        Python slicing notation
        '''
    
    lrem(self, name, count, value)
        '''
        Remove the first ``count`` occurrences of elements equal to ``value``
        from the list stored at ``name``.
        
        The count argument influences the operation in the following ways:
            count > 0: Remove elements equal to value moving from head to tail.
            count < 0: Remove elements equal to value moving from tail to head.
            count = 0: Remove all elements equal to value.
        '''
    
    lset(self, name, index, value)
        '''Set ``position`` of list ``name`` to ``value``'''
    
    ltrim(self, name, start, end)
    	'''
        Trim the list ``name``, removing all values not within the slice
        between ``start`` and ``end``
        
        ``start`` and ``end`` can be negative numbers just like
        Python slicing notation
    	'''

    memory_purge(self)
        '''Attempts to purge dirty pages for reclamation by allocator'''
    
    memory_usage(self, key, samples=None)
        '''
        Return the total memory usage for key, its value and associated
        administrative overheads.
        
        For nested data structures, ``samples`` is the number of elements to
        sample. If left unspecified, the server's default is 5. Use 0 to sample
        all elements.
        '''
    
    mget(self, keys, *args)
       ''' Returns a list of values ordered identically to ``keys``'''
    
    migrate(self, host, port, keys, destination_db, timeout, copy=False, replace=False, auth=None)
        '''
        Migrate 1 or more keys from the current Redis server to a different
        server specified by the ``host``, ``port`` and ``destination_db``.
        
        The ``timeout``, specified in milliseconds, indicates the maximum
        time the connection between the two servers can be idle before the
        command is interrupted.
        
        If ``copy`` is True, the specified ``keys`` are NOT deleted from
        the source server.
        
        If ``replace`` is True, this operation will overwrite the keys
        on the destination server if they exist.
        
        If ``auth`` is specified, authenticate to the destination server with
        the password provided.
    	'''

    move(self, name, db)
        '''Moves the key ``name`` to a different Redis database ``db``'''
    
    mset(self, mapping)
        '''
        Sets key/values based on a mapping. Mapping is a dictionary of
        key/value pairs. Both keys and values should be strings or types that
        can be cast to a string via str().
        '''
    
    msetnx(self, mapping)
        '''
        Sets key/values based on a mapping if none of the keys are already set.
        Mapping is a dictionary of key/value pairs. Both keys and values
        should be strings or types that can be cast to a string via str().
        Returns a boolean indicating if the operation was successful.
        '''
    
    object(self, infotype, key)
        '''Return the encoding, idletime, or refcount about the key'''
    
    parse_response(self, connection, command_name, **options)
        '''Parses a response from the Redis server'''
    
    persist(self, name)
        '''Removes an expiration on ``name``'''
    
    pexpire(self, name, time)
        '''
        Set an expire flag on key ``name`` for ``time`` milliseconds.
        ``time`` can be represented by an integer or a Python timedelta
        object.
        '''
    
    pexpireat(self, name, when)
        '''
        Set an expire flag on key ``name``. ``when`` can be represented
        as an integer representing unix time in milliseconds (unix time * 1000)
        or a Python datetime object.
        '''
    
    pfadd(self, name, *values)
        '''Adds the specified elements to the specified HyperLogLog.'''
    
    pfcount(self, *sources)
        '''
        Return the approximated cardinality of
        the set observed by the HyperLogLog at key(s).
        '''
    
    pfmerge(self, dest, *sources)
        '''Merge N different HyperLogLogs into a single one.'''
    
    ping(self)
        '''Ping the Redis server'''
    
    pipeline(self, transaction=True, shard_hint=None)
        '''
        Return a new pipeline object that can queue multiple commands for
        later execution. ``transaction`` indicates whether all commands
        should be executed atomically. Apart from making a group of operations
        atomic, pipelines are useful for reducing the back-and-forth overhead
        between the client and server.
        '''
    
    psetex(self, name, time_ms, value)
        '''
        Set the value of key ``name`` to ``value`` that expires in ``time_ms``
        milliseconds. ``time_ms`` can be represented by an integer or a Python
        timedelta object
        '''
    
    pttl(self, name)
        '''Returns the number of milliseconds until the key ``name`` will expire'''
    
    publish(self, channel, message)
        '''
        Publish ``message`` on ``channel``.
        Returns the number of subscribers the message was delivered to.
    	'''

    pubsub(self, **kwargs)
        '''
        Return a Publish/Subscribe object. With this object, you can
        subscribe to channels and listen for messages that get published to
        them.
        '''
    
    pubsub_channels(self, pattern='*')
        '''Return a list of channels that have at least one subscriber'''
    
    pubsub_numpat(self)
        '''Returns the number of subscriptions to patterns'''
    
    pubsub_numsub(self, *args)
        '''
        Return a list of (channel, number of subscribers) tuples
        for each channel given in ``*args``
    	'''

    randomkey(self)
        '''Returns the name of a random key'''
    
    register_script(self, script)
        '''
        Register a Lua ``script`` specifying the ``keys`` it will touch.
        Returns a Script object that is callable and hides the complexity of
        deal with scripts, keys, and shas. This is the preferred way to work
        with Lua scripts.
        '''
    
    rename(self, src, dst)
        '''Rename key ``src`` to ``dst``'''
    
    renamenx(self, src, dst)
        '''Rename key ``src`` to ``dst`` if ``dst`` doesn't already exist'''
    
    restore(self, name, ttl, value, replace=False)
        '''
        Create a key using the provided serialized value, previously obtained
        using DUMP.
    	'''

    rpop(self, name)
        '''Remove and return the last item of the list ``name``'''
    
    rpoplpush(self, src, dst)
        '''
        RPOP a value off of the ``src`` list and atomically LPUSH it
        on to the ``dst`` list.  Returns the value.
        '''
    
    rpush(self, name, *values)
        '''Push ``values`` onto the tail of the list ``name``'''
    
    rpushx(self, name, value)
        '''Push ``value`` onto the tail of the list ``name`` if ``name`` exists'''
    
    sadd(self, name, *values)
        '''Add ``value(s)`` to set ``name``'''
    
    save(self)
        '''
        Tell the Redis server to save its data to disk,
        blocking until the save is complete
        '''
    
    scan(self, cursor=0, match=None, count=None)
        '''
        Incrementally return lists of key names. Also return a cursor
        indicating the scan position.
        
        ``match`` allows for filtering the keys by pattern
        
        ``count`` allows for hint the minimum number of returns
        '''
    
    scan_iter(self, match=None, count=None)
    	'''
        Make an iterator using the SCAN command so that the client doesn't
        need to remember the cursor position.
        
        ``match`` allows for filtering the keys by pattern
        
        ``count`` allows for hint the minimum number of returns
    	'''
    scard(self, name)
        '''Return the number of elements in set ``name``'''
    
    script_exists(self, *args)
    '''
        Check if a script exists in the script cache by specifying the SHAs of
        each script as ``args``. Returns a list of boolean values indicating if
        if each already script exists in the cache.
    '''

    script_flush(self)
        '''Flush all scripts from the script cache'''
    
    script_kill(self)
        '''Kill the currently executing Lua script'''
    
    script_load(self, script)
        '''Load a Lua ``script`` into the script cache. Returns the SHA.'''
    
    sdiff(self, keys, *args)
        '''Return the difference of sets specified by ``keys``'''
    
    sdiffstore(self, dest, keys, *args)
    '''    
        Store the difference of sets specified by ``keys`` into a new
        set named ``dest``.  Returns the number of keys in the new set.
    '''

    sentinel(self, *args)
        '''Redis Sentinel's SENTINEL command.'''
    
    sentinel_get_master_addr_by_name(self, service_name)
        '''Returns a (host, port) pair for the given ``service_name``'''
    
    sentinel_master(self, service_name)
        '''Returns a dictionary containing the specified masters state.'''
    
    sentinel_masters(self)
        '''Returns a list of dictionaries containing each master's state.'''
    
    sentinel_monitor(self, name, ip, port, quorum)
        '''Add a new master to Sentinel to be monitored'''
    
    sentinel_remove(self, name)
        '''Remove a master from Sentinel's monitoring'''
    
    sentinel_sentinels(self, service_name)
        '''Returns a list of sentinels for ``service_name``'''
    
    sentinel_set(self, name, option, value)
        '''Set Sentinel monitoring parameters for a given master'''
    
    sentinel_slaves(self, service_name)
        '''Returns a list of slaves for ``service_name``'''
    
    set(self, name, value, ex=None, px=None, nx=False, xx=False)
    '''    
        Set the value at key ``name`` to ``value``
        
        ``ex`` sets an expire flag on key ``name`` for ``ex`` seconds.
        
        ``px`` sets an expire flag on key ``name`` for ``px`` milliseconds.
        
        ``nx`` if set to True, set the value at key ``name`` to ``value`` only
            if it does not exist.
        
        ``xx`` if set to True, set the value at key ``name`` to ``value`` only
            if it already exists.
    '''

    set_response_callback(self, command, callback)
        '''Set a custom Response Callback'''
    
    setbit(self, name, offset, value)
    '''
        Flag the ``offset`` in ``name`` as ``value``. Returns a boolean
        indicating the previous value of ``offset``.
    '''

    setex(self, name, time, value)
    '''
        Set the value of key ``name`` to ``value`` that expires in ``time``
        seconds. ``time`` can be represented by an integer or a Python
        timedelta object.
    '''

    setnx(self, name, value)
        '''Set the value of key ``name`` to ``value`` if key doesn't exist'''
    
    setrange(self, name, offset, value)
    '''
        Overwrite bytes in the value of ``name`` starting at ``offset`` with
        ``value``. If ``offset`` plus the length of ``value`` exceeds the
        length of the original value, the new value will be larger than before.
        If ``offset`` exceeds the length of the original value, null bytes
        will be used to pad between the end of the previous value and the start
        of what's being injected.
        
        Returns the length of the new string.
    '''

    shutdown(self, save=False, nosave=False)
    '''
        Shutdown the Redis server.  If Redis has persistence configured,
        data will be flushed before shutdown.  If the "save" option is set,
        a data flush will be attempted even if there is no persistence
        configured.  If the "nosave" option is set, no data flush will be
        attempted.  The "save" and "nosave" options cannot both be set.
    '''
    
    sinter(self, keys, *args)
        '''Return the intersection of sets specified by ``keys``'''
    
    sinterstore(self, dest, keys, *args)
    '''
        Store the intersection of sets specified by ``keys`` into a new
        set named ``dest``.  Returns the number of keys in the new set.
    '''

    sismember(self, name, value)
        '''Return a boolean indicating if ``value`` is a member of set ``name``'''
    
    slaveof(self, host=None, port=None)
    '''    
        Set the server to be a replicated slave of the instance identified
        by the ``host`` and ``port``. If called without arguments, the
        instance is promoted to a master instead.
    '''

    slowlog_get(self, num=None)
    '''
        Get the entries from the slowlog. If ``num`` is specified, get the
        most recent ``num`` items.
    '''

    slowlog_len(self)
        '''Get the number of items in the slowlog'''
    
    slowlog_reset(self)
        '''Remove all items in the slowlog'''
    
    smembers(self, name)
        '''Return all members of the set ``name``'''
    
    smove(self, src, dst, value)
        '''Move ``value`` from set ``src`` to set ``dst`` atomically'''
    
    sort(self, name, start=None, num=None, by=None, get=None, desc=False, alpha=False, store=None, groups=False)
    '''
        Sort and return the list, set or sorted set at ``name``.
        
        ``start`` and ``num`` allow for paging through the sorted data
        
        ``by`` allows using an external key to weight and sort the items.
            Use an "*" to indicate where in the key the item value is located
        
        ``get`` allows for returning items from external keys rather than the
            sorted data itself.  Use an "*" to indicate where int he key
            the item value is located
        
        ``desc`` allows for reversing the sort
        
        ``alpha`` allows for sorting lexicographically rather than numerically
        
        ``store`` allows for storing the result of the sort into
            the key ``store``
        
        ``groups`` if set to True and if ``get`` contains at least two
            elements, sort will return a list of tuples, each containing the
            values fetched from the arguments to ``get``.
    '''

    spop(self, name, count=None)
        '''Remove and return a random member of set ``name``'''
    
    srandmember(self, name, number=None)
    '''    
    	If ``number`` is None, returns a random member of set ``name``.
        
        If ``number`` is supplied, returns a list of ``number`` random
        memebers of set ``name``. Note this is only available when running
        Redis 2.6+.
    '''

    srem(self, name, *values)
        '''Remove ``values`` from set ``name``'''
    
    sscan(self, name, cursor=0, match=None, count=None)
    '''
        Incrementally return lists of elements in a set. Also return a cursor
        indicating the scan position.
        
        ``match`` allows for filtering the keys by pattern
        
        ``count`` allows for hint the minimum number of returns
    '''

    sscan_iter(self, name, match=None, count=None)
    '''
        Make an iterator using the SSCAN command so that the client doesn't
        need to remember the cursor position.
        
        ``match`` allows for filtering the keys by pattern
        
        ``count`` allows for hint the minimum number of returns
    '''

    strlen(self, name)
        '''Return the number of bytes stored in the value of ``name``'''
    
    substr(self, name, start, end=-1)
    '''
        Return a substring of the string at key ``name``. ``start`` and ``end``
        are 0-based integers specifying the portion of the string to return.
    '''

    sunion(self, keys, *args)
        '''Return the union of sets specified by ``keys``'''
    
    sunionstore(self, dest, keys, *args)
    '''
        Store the union of sets specified by ``keys`` into a new
        set named ``dest``.  Returns the number of keys in the new set.
    '''

    swapdb(self, first, second)
        '''Swap two databases'''
    
    time(self)
    '''    
    	Returns the server time as a 2-item tuple of ints:
        (seconds since epoch, microseconds into this second).
    '''

    touch(self, *args)
    '''
        Alters the last access time of a key(s) ``*args``. A key is ignored
        if it does not exist.
    '''

    transaction(self, func, *watches, **kwargs)
    '''
        Convenience method for executing the callable `func` as a transaction
        while watching all keys specified in `watches`. The 'func' callable
        should expect a single argument which is a Pipeline object.
    '''

    ttl(self, name)
        '''Returns the number of seconds until the key ``name`` will expire'''
    
    type(self, name)
        '''Returns the type of key ``name``'''
    
    unlink(self, *names)
        '''Unlink one or more keys specified by ``names``'''
    
    unwatch(self)
        '''Unwatches the value at key ``name``, or None of the key doesn't exist'''
    
    wait(self, num_replicas, timeout)
    '''
        Redis synchronous replication
        That returns the number of replicas that processed the query when
        we finally have at least ``num_replicas``, or when the ``timeout`` was
        reached.
    '''

    watch(self, *names)
        '''Watches the values at keys ``names``, or None if the key doesn't exist'''
    
    xack(self, name, groupname, *ids)
    '''    
    	Acknowledges the successful processing of one or more messages.
        name: name of the stream.
        groupname: name of the consumer group.
        *ids: message ids to acknowlege.
    '''

    xadd(self, name, fields, id='*', maxlen=None, approximate=True)
    '''
        Add to a stream.
        name: name of the stream
        fields: dict of field/value pairs to insert into the stream
        id: Location to insert this record. By default it is appended.
        maxlen: truncate old stream members beyond this size
        approximate: actual stream length may be slightly more than maxlen
    '''

    xclaim(self, name, groupname, consumername, min_idle_time, message_ids, idle=None, time=None, retrycount=None, force=False, justid=False)
    '''
        Changes the ownership of a pending message.
        name: name of the stream.
        groupname: name of the consumer group.
        consumername: name of a consumer that claims the message.
        min_idle_time: filter messages that were idle less than this amount of
        milliseconds
        message_ids: non-empty list or tuple of message IDs to claim
        idle: optional. Set the idle time (last time it was delivered) of the
         message in ms
        time: optional integer. This is the same as idle but instead of a
         relative amount of milliseconds, it sets the idle time to a specific
         Unix time (in milliseconds).
        retrycount: optional integer. set the retry counter to the specified
         value. This counter is incremented every time a message is delivered
         again.
        force: optional boolean, false by default. Creates the pending message
         entry in the PEL even if certain specified IDs are not already in the
         PEL assigned to a different client.
        justid: optional boolean, false by default. Return just an array of IDs
         of messages successfully claimed, without returning the actual message
    '''

    xdel(self, name, *ids)
    '''
        Deletes one or more messages from a stream.
        name: name of the stream.
        *ids: message ids to delete.
    '''

    xgroup_create(self, name, groupname, id='$', mkstream=False)
    '''
        Create a new consumer group associated with a stream.
        name: name of the stream.
        groupname: name of the consumer group.
        id: ID of the last item in the stream to consider already delivered.
    '''

    xgroup_delconsumer(self, name, groupname, consumername)
    '''
        Remove a specific consumer from a consumer group.
        Returns the number of pending messages that the consumer had before it
        was deleted.
        name: name of the stream.
        groupname: name of the consumer group.
        consumername: name of consumer to delete
    '''

    xgroup_destroy(self, name, groupname)
    ''' 
        Destroy a consumer group.
        name: name of the stream.
        groupname: name of the consumer group.
    '''

    xgroup_setid(self, name, groupname, id)
    '''
        Set the consumer group last delivered ID to something else.
        name: name of the stream.
        groupname: name of the consumer group.
        id: ID of the last item in the stream to consider already delivered.
    '''

    xinfo_consumers(self, name, groupname)
    '''
        Returns general information about the consumers in the group.
        name: name of the stream.
        groupname: name of the consumer group.
    '''

    xinfo_groups(self, name)
    '''
        Returns general information about the consumer groups of the stream.
        name: name of the stream.
    '''

    xinfo_stream(self, name)
    '''
        Returns general information about the stream.
        name: name of the stream.
    '''

    xlen(self, name)
        '''Returns the number of elements in a given stream.'''
    
    xpending(self, name, groupname)
    '''
        Returns information about pending messages of a group.
        name: name of the stream.
        groupname: name of the consumer group.
    '''

    xpending_range(self, name, groupname, min, max, count, consumername=None)
    '''
        Returns information about pending messages, in a range.
        name: name of the stream.
        groupname: name of the consumer group.
        min: minimum stream ID.
        max: maximum stream ID.
        count: number of messages to return
        consumername: name of a consumer to filter by (optional).
    '''

    xrange(self, name, min='-', max='+', count=None)
    '''
        Read stream values within an interval.
        name: name of the stream.
        start: first stream ID. defaults to '-',
               meaning the earliest available.
        finish: last stream ID. defaults to '+',
                meaning the latest available.
        count: if set, only return this many items, beginning with the
               earliest available.
    '''

    xread(self, streams, count=None, block=None)
    '''
        Block and monitor multiple streams for new data.
        streams: a dict of stream names to stream IDs, where
                   IDs indicate the last ID already seen.
        count: if set, only return this many items, beginning with the
               earliest available.
        block: number of milliseconds to wait, if nothing already present.
    '''

    xreadgroup(self, groupname, consumername, streams, count=None, block=None, noack=False)
    '''
        Read from a stream via a consumer group.
        groupname: name of the consumer group.
        consumername: name of the requesting consumer.
        streams: a dict of stream names to stream IDs, where
               IDs indicate the last ID already seen.
        count: if set, only return this many items, beginning with the
               earliest available.
        block: number of milliseconds to wait, if nothing already present.
        noack: do not add messages to the PEL
    '''

    xrevrange(self, name, max='+', min='-', count=None)
    '''
        Read stream values within an interval, in reverse order.
        name: name of the stream
        start: first stream ID. defaults to '+',
               meaning the latest available.
        finish: last stream ID. defaults to '-',
                meaning the earliest available.
        count: if set, only return this many items, beginning with the
               latest available.
    '''

    xtrim(self, name, maxlen, approximate=True)
    '''
        Trims old messages from a stream.
        name: name of the stream.
        maxlen: truncate old stream messages beyond this size
        approximate: actual stream length may be slightly more than maxlen
    '''

    zadd(self, name, mapping, nx=False, xx=False, ch=False, incr=False)
    '''
        Set any number of element-name, score pairs to the key ``name``. Pairs
        are specified as a dict of element-names keys to score values.

        mapping    {'element-name':'score'}
        
        ``nx`` forces ZADD to only create new elements and not to update
        scores for elements that already exist.
        
        ``xx`` forces ZADD to only update scores of elements that already
        exist. New elements will not be added.
        
        ``ch`` modifies the return value to be the numbers of elements changed.
        Changed elements include new elements that were added and elements
        whose scores changed.
        
        ``incr`` modifies ZADD to behave like ZINCRBY. In this mode only a
        single element/score pair can be specified and the score is the amount
        the existing score will be incremented by. When using this mode the
        return value of ZADD will be the new score of the element.
        
        The return value of ZADD varies based on the mode specified. With no
        options, ZADD returns the number of new elements added to the sorted
        set.
    '''

    zcard(self, name)
        '''Return the number of elements in the sorted set ``name``'''
    
    zcount(self, name, min, max)
    '''
        Returns the number of elements in the sorted set at key ``name`` with
        a score between ``min`` and ``max``.
    '''

    zincrby(self, name, amount, value)
        '''Increment the score of ``value`` in sorted set ``name`` by ``amount``'''
    
    zinterstore(self, dest, keys, aggregate=None)
    '''
        Intersect multiple sorted sets specified by ``keys`` into
        a new sorted set, ``dest``. Scores in the destination will be
        aggregated based on the ``aggregate``, or SUM if none is provided.
    '''

    zlexcount(self, name, min, max)
    '''
        Return the number of items in the sorted set ``name`` between the
        lexicographical range ``min`` and ``max``.
    '''

    zpopmax(self, name, count=None)
    '''
        Remove and return up to ``count`` members with the highest scores
        from the sorted set ``name``.
    '''

    zpopmin(self, name, count=None)
    '''
        Remove and return up to ``count`` members with the lowest scores
        from the sorted set ``name``.
    '''

    zrange(self, name, start, end, desc=False, withscores=False, score_cast_func=<class 'float'>)
    '''
        Return a range of values from sorted set ``name`` between
        ``start`` and ``end`` sorted in ascending order.
        
        ``start`` and ``end`` can be negative, indicating the end of the range.
        
        ``desc`` a boolean indicating whether to sort the results descendingly
        
        ``withscores`` indicates to return the scores along with the values.
        The return type is a list of (value, score) pairs
        
        ``score_cast_func`` a callable used to cast the score return value
    '''

    zrangebylex(self, name, min, max, start=None, num=None)
    '''
        Return the lexicographical range of values from sorted set ``name``
        between ``min`` and ``max``.
        
        If ``start`` and ``num`` are specified, then return a slice of the
        range.
    '''

    zrangebyscore(self, name, min, max, start=None, num=None, withscores=False, score_cast_func=<class 'float'>)
    '''
        Return a range of values from the sorted set ``name`` with scores
        between ``min`` and ``max``.
        
        If ``start`` and ``num`` are specified, then return a slice
        of the range.
        
        ``withscores`` indicates to return the scores along with the values.
        The return type is a list of (value, score) pairs
        
        `score_cast_func`` a callable used to cast the score return value
    '''

    zrank(self, name, value)
    '''
        Returns a 0-based value indicating the rank of ``value`` in sorted set
        ``name``
    '''

    zrem(self, name, *values)
        '''Remove member ``values`` from sorted set ``name``'''
    
    zremrangebylex(self, name, min, max)
    '''
        Remove all elements in the sorted set ``name`` between the
        lexicographical range specified by ``min`` and ``max``.
        
        Returns the number of elements removed.
    '''

    zremrangebyrank(self, name, min, max)
    '''
        Remove all elements in the sorted set ``name`` with ranks between
        ``min`` and ``max``. Values are 0-based, ordered from smallest score
        to largest. Values can be negative indicating the highest scores.
        Returns the number of elements removed
    '''

    zremrangebyscore(self, name, min, max)
    '''
        Remove all elements in the sorted set ``name`` with scores
        between ``min`` and ``max``. Returns the number of elements removed.
    '''

    zrevrange(self, name, start, end, withscores=False, score_cast_func=<class 'float'>)
    '''
        Return a range of values from sorted set ``name`` between
        ``start`` and ``end`` sorted in descending order.
        
        ``start`` and ``end`` can be negative, indicating the end of the range.
        
        ``withscores`` indicates to return the scores along with the values
        The return type is a list of (value, score) pairs
        
        ``score_cast_func`` a callable used to cast the score return value
    '''

    zrevrangebylex(self, name, max, min, start=None, num=None)
    '''
        Return the reversed lexicographical range of values from sorted set
        ``name`` between ``max`` and ``min``.
        
        If ``start`` and ``num`` are specified, then return a slice of the
        range.
    '''

    zrevrangebyscore(self, name, max, min, start=None, num=None, withscores=False, score_cast_func=<class 'float'>)
    '''
        Return a range of values from the sorted set ``name`` with scores
        between ``min`` and ``max`` in descending order.
        
        If ``start`` and ``num`` are specified, then return a slice
        of the range.
        
        ``withscores`` indicates to return the scores along with the values.
        The return type is a list of (value, score) pairs
        
        ``score_cast_func`` a callable used to cast the score return value
    '''

    zrevrank(self, name, value)
    '''
        Returns a 0-based value indicating the descending rank of
        ``value`` in sorted set ``name``
    '''

    zscan(self, name, cursor=0, match=None, count=None, score_cast_func=<class 'float'>)
    '''
        Incrementally return lists of elements in a sorted set. Also return a
        cursor indicating the scan position.
        
        ``match`` allows for filtering the keys by pattern
        
        ``count`` allows for hint the minimum number of returns
        
        ``score_cast_func`` a callable used to cast the score return value
    '''

    zscan_iter(self, name, match=None, count=None, score_cast_func=<class 'float'>)
    '''
        Make an iterator using the ZSCAN command so that the client doesn't
        need to remember the cursor position.
        
        ``match`` allows for filtering the keys by pattern
        
        ``count`` allows for hint the minimum number of returns
        
        ``score_cast_func`` a callable used to cast the score return value
    '''

    zscore(self, name, value)
        '''Return the score of element ``value`` in sorted set ``name``'''
    
    zunionstore(self, dest, keys, aggregate=None)
    '''
        Union multiple sorted sets specified by ``keys`` into
        a new sorted set, ``dest``. Scores in the destination will be
        aggregated based on the ``aggregate``, or SUM if none is provided.
    '''

    # ----------------------------------------------------------------------
    '''Class methods defined here:'''
    
    from_url(url, db=None, **kwargs) from builtins.type
        '''
        Return a Redis client object configured from the given URL
        
        For example::
        
            redis://[:password]@localhost:6379/0
            rediss://[:password]@localhost:6379/0
            unix://[:password]@/path/to/socket.sock?db=0
        
        Three URL schemes are supported:
        
        - ```redis://``
          <http://www.iana.org/assignments/uri-schemes/prov/redis>`_ creates a
          normal TCP socket connection
        - ```rediss://``
          <http://www.iana.org/assignments/uri-schemes/prov/rediss>`_ creates a
          SSL wrapped TCP socket connection
        - ``unix://`` creates a Unix Domain Socket connection
        
        There are several ways to specify a database number. The parse function
        will return the first specified option:
            1. A ``db`` querystring option, e.g. redis://localhost?db=0
            2. If using the redis:// scheme, the path argument of the url, e.g.
               redis://localhost/0
            3. The ``db`` argument to this function.
        
        If none of these options are specified, db=0 is used.
        
        Any additional querystring arguments and keyword arguments will be
        passed along to the ConnectionPool class's initializer. In the case
        of conflicting arguments, querystring arguments always win.
    	'''

    # ----------------------------------------------------------------------
    '''Data descriptors defined here:'''
    
    __dict__
        '''dictionary for instance variables (if defined)'''
    
    __weakref__
        '''list of weak references to the object (if defined)'''
    
    # ----------------------------------------------------------------------
    '''Data and other attributes defined here:'''
    
    RESPONSE_CALLBACKS = {'AUTH': <class 'bool'>, 'BGREWRITEAOF': <functio...

POP vs OOP

[TOC]

POP

Procedure-Oriented Programming

以过程为中心，试图使问题满足语言的过程性方法，强调编程的算法

OOP

Object-Oriented Programming

以对象为中心，试图让语言来满足问题的要求，强调数据

Copyright © 2020 Fzg5_Shelling | Powered by Hexo | Theme by Snippet | Deploys by Netlify