-
-
Notifications
You must be signed in to change notification settings - Fork 105
feat: add proxy support #287
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Open
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
e864ff4
Add proxy prototype.
LucienRay 57440bf
Improve proxy option help message
LucienRay 9336931
Add proxy format validation
LucienRay 8db06d2
Improve proxy option help message
LucienRay c416ab6
Add proxy validation and reachability check
LucienRay 5c0b7d5
Fix linting issues
LucienRay 70964d6
Fix linting issues
LucienRay File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| #!/usr/bin/env python3 | ||
| # PYTHON_ARGCOMPLETE_OK | ||
|
|
||
| import socket | ||
| import sys | ||
| import os | ||
| import re | ||
|
|
@@ -10,8 +10,8 @@ | |
| from datetime import datetime | ||
| from io import BytesIO | ||
| from typing import List, Optional, Tuple, Union | ||
| from urllib.parse import quote | ||
| from urllib.request import urlopen, Request | ||
| from urllib.parse import quote, urlparse | ||
| from urllib.request import urlopen, Request, ProxyHandler, build_opener, install_opener | ||
| from urllib.error import HTTPError, URLError | ||
| from termcolor import colored | ||
| import ssl | ||
|
|
@@ -564,6 +564,35 @@ def clear_cache(language: Optional[List[str]] = None) -> None: | |
| print(f"No cache directory found for language {language}") | ||
|
|
||
|
|
||
| def check_proxy(proxy: str) -> None: | ||
| if not proxy.startswith("https://") or ":" not in proxy: | ||
| sys.exit("Error: Invalid proxy format. Expected 'https://host:port'.") | ||
|
|
||
| parsed = urlparse(proxy) | ||
| host = parsed.hostname | ||
| port = parsed.port | ||
|
|
||
| if not host or not port: | ||
| sys.exit(f"Error: Could not extract host/port from proxy URL: {proxy}") | ||
|
|
||
| try: | ||
| sock = socket.create_connection((host, port), timeout=10) | ||
| sock.close() | ||
| except socket.timeout: | ||
| sys.exit(f"Error: Proxy server {host}:{port} " | ||
| "connection timed out after 10 seconds.") | ||
| except socket.error as e: | ||
| sys.exit(f"Error: Could not connect to proxy server {host}:{port}. Error: {e}") | ||
|
|
||
|
|
||
| def set_proxy(proxy: str) -> None: | ||
| check_proxy(proxy) | ||
| proxyHandler = ProxyHandler({'http': f'{proxy}', | ||
| 'https': f'{proxy}'}) | ||
| opener = build_opener(proxyHandler) | ||
| install_opener(opener) | ||
|
|
||
|
|
||
| def create_parser() -> ArgumentParser: | ||
| parser = ArgumentParser( | ||
| prog="tldr", | ||
|
|
@@ -648,6 +677,13 @@ def create_parser() -> ArgumentParser: | |
| action="store_true", | ||
| help='Display longform options over shortform') | ||
|
|
||
| parser.add_argument('-x', '--proxy', | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I assume the There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah, I actually borrowed that from how cURL uses it for proxies. About that client spec reservation point, I wasn't really sure if we had a standard for short flags yet, or if there's one planned. If -x might clash with anything down the line, I'm totally open to changing it! |
||
| default=None, | ||
| type=str, | ||
| help='Specify a proxy server address. When a proxy is used, ' | ||
| 'only HTTPS connections will be routed through it. ' | ||
| 'Example: https://host:port.') | ||
|
|
||
| parser.add_argument( | ||
| 'command', type=str, nargs='*', help="command to lookup", metavar='command' | ||
| ).complete = {"bash": "shtab_tldr_cmd_list", "zsh": "shtab_tldr_cmd_list"} | ||
|
|
@@ -689,6 +725,9 @@ def main() -> None: | |
| if options.color is False: | ||
| os.environ["FORCE_COLOR"] = "true" | ||
|
|
||
| if options.proxy is not None: | ||
| set_proxy(options.proxy) | ||
|
|
||
| if options.update: | ||
| update_cache(language=options.language) | ||
| return | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.