DOCOPT.PY:165:(1)

📦 version 0.7.3, in fedora 43

🎀 docopt.py:165: — the manual page, bestie (section 1) 🎀

okay so this is the manual page for docopt.py:165:, and yes it is section 1 of the manual, and yes the name is a whole mouthful, we love that for it 💅. It's giving "a Python file decided to start yelling warnings and someone made a manpage out of the yelling." Iconic behaviour, honestly.

📛 NAME ✨

This is the manual page for docopt.py:165:, and the name field reads, verbatim and unhinged:

SyntaxWarning: "s an invalid escape sequence. Such sequences will not work in the future. Did you mean "\S"? A raw string is also an option.

fr fr, that's the whole name. No cap. 🫶

🧚 DESCRIPTION 💜

okay bestie, deep breath, because the description is literally just a parade of SyntaxWarnings coming out of /usr/lib/python3.14/site-packages/docopt.py, each one dragging a line of code behind it like a little entourage. Let's go one by one, no skipping, we do not skip here 🌸

/usr/lib/python3.14/site-packages/docopt.py:165 hits you with:

SyntaxWarning: "\S" is an invalid escape sequence. Such sequences will not work in the future. Did you mean "\\S"? A raw string is also an option.

and the guilty line is:

name = re.findall('(<\S*?>)', source)[0]

/usr/lib/python3.14/site-packages/docopt.py:166 is up next:

SyntaxWarning: "\[" is an invalid escape sequence. Such sequences will not work in the future. Did you mean "\\["? A raw string is also an option.

and here's the line it's mad about:

value = re.findall('\[default: (.*)\]', source, flags=re.I)

/usr/lib/python3.14/site-packages/docopt.py:207 said "me too, same energy":

SyntaxWarning: "\[" is an invalid escape sequence. Such sequences will not work in the future. Did you mean "\\["? A raw string is also an option.

guilty party:

matched = re.findall('\[default: (.*)\]', description, flags=re.I)

and finally /usr/lib/python3.14/site-packages/docopt.py:456 closes the set:

SyntaxWarning: "\S" is an invalid escape sequence. Such sequences will not work in the future. Did you mean "\\S"? A raw string is also an option.

with:

split = re.split('\n *(<\S+?>|-\S+?)', doc)[1:]
⚠️ heads up bestie: these are warnings, and the message is very clear that sequences like these will not work in the future. So it's not "oops cute bug", it's "this is gonna break eventually, fix your escapes, or use a raw string, that's also an option" 💀

🌈 Usage 🦋

the usage line, exactly as it lives:

vpoller-client [options] -m <method> -V <host>

that's the shape of it: vpoller-client, some [options], then a method and a host, both mandatory. slay. ✨

💅 OPTIONS 👑

every single one, in order, nothing dropped, periodt:

  • -h, --help — Display this usage info 💖
  • -v, --version — Display version and exit 🌸
  • -d, --debug — Debug mode, be more verbose 🔥
  • -m <method>, --method <method> — The method to be processed during the client request 👑
  • -V <host>, --vsphere-host <host> — The vSphere host to send the request to 🦋
  • -n <name>, --name <name> — Name of the object, e.g. ESXi hostname, datastore URL, etc. 🎀
  • -p <properties>, --properties <properties> — Name of the property as defined by the vSphere Web SDK 💜
  • -r <retries>, --retries <retries> — Number of times to retry if a request times out [default: 3] ⭐
  • -t <timeout>, --timeout <timeout> — Timeout after that period of milliseconds [default: 10000] ⏳
  • -e <endpoint>, --endpoint <endpoint> — Endpoint of vPoller Proxy/Worker the client connects to [default: tcp://localhost:10123] 🌈
  • -k <key>, --key <key> — Provide additional key for data filtering 🔑
  • -c <counter>, --counter <counter> — Retrieve performance metrics with this counter name 📊
  • -s <max-sample>, --max-sample <max-sample> — Max number of performance samples to retrieve 🍓
  • -i <instance>, --instance <instance> — Performance metric instance name 🧚
  • -T <interval> --perf-interval <interval> — Historical performance interval name ⌛
  • -U <username>, --guest-username <username> — Username to use for authentication in guest system 🙈
  • -P <password>, --guest-password <password> — Password to use for authentication in guest system 🔐
  • -H <helper>, --helper <helper> — Specify a helper module to use for processing of the result message, e.g. 'vpoller.helpers.zabbix' 🫶

🍓 EXAMPLES 💖

here's the example block, and yes the commands are all squished together in the original, so I'm giving each one its own line so your eyeballs can vibe check them properly. all the characters are the same, promise 🤞

vpoller-client -m vm.discover -V vc01.example.org
vpoller-client -m vm.discover -V vc01.example.org -p runtime.powerState
vpoller-client -m vm.get -V vc01.example.org -n vm01.example.org -p summary.overallStatus
vpoller-client -m vm.disk.get -V vc01.example.org -n vm01.example.org -k /var
vpoller-client -m vm.process.get -V vc01.example.org -n vm01.example.org -U user -P pass

and then — okay this part is so extra — the examples section just starts spitting the same warnings again, like it forgot it already did that 😭 keeping all of it, obviously:

name = re.findall('(<\S*?>)', source)[0]

/usr/lib/python3.14/site-packages/docopt.py:166:

SyntaxWarning: "\[" is an invalid escape sequence. Such sequences will not work in the future. Did you mean "\\["? A raw string is also an option.
value = re.findall('\[default: (.*)\]', source, flags=re.I)

/usr/lib/python3.14/site-packages/docopt.py:207:

SyntaxWarning: "\[" is an invalid escape sequence. Such sequences will not work in the future. Did you mean "\\["? A raw string is also an option.
matched = re.findall('\[default: (.*)\]', description, flags=re.I)

/usr/lib/python3.14/site-packages/docopt.py:456:

SyntaxWarning: "\S" is an invalid escape sequence. Such sequences will not work in the future. Did you mean "\\S"? A raw string is also an option.
split = re.split('\n *(<\S+?>|-\S+?)', doc)[1:]

⭐ 0.7.3 🌟

that's the version, bestie. short, sweet, just vibes.

🔍 SEE ALSO 👀

the full documentation for docopt.py:165: is maintained as a Texinfo manual. If the info and docopt.py:165: programs are properly installed at your site, this command:

info docopt.py:165:

should give you access to the complete manual. iykyk 📚✨

okay and the cute sign-off, as promised: this whole page is stamped docopt.py:165: SyntaxWarning: as its source/version string, dated September 2025, and it lives up in the header corner as DOCOPT.PY:165:(1). that's it, that's the page, go fix your escape sequences bestie 💅💖🦋

📦 where this page comes from