".%s', RED, STASH_SAVE, END_FORMAT)
return
stash_list = [{'command': cmd, 'fields': field} for cmd, field in commands.items()]
prompt_stash_remove(args, stash_list)
return
if not args['query']:
parser.print_help()
return
if os.getenv('HOWDOI_COLORIZE'):
args['color'] = True
howdoi_result = howdoi(args)
if os.name == 'nt':
# Windows
print(howdoi_result)
else:
utf8_result = howdoi_result.encode('utf-8', 'ignore')
# Write UTF-8 to stdout: https://stackoverflow.com/a/3603160
sys.stdout.buffer.write(utf8_result)
# close the session to release connection
howdoi_session.close()
if __name__ == '__main__':
command_line_runner()
././@PaxHeader 0000000 0000000 0000000 00000000034 00000000000 010212 x ustar 00 28 mtime=1664818366.1095142
howdoi-2.0.20/howdoi.egg-info/ 0000755 0000765 0000024 00000000000 14316616276 015304 5 ustar 00gleitz staff ././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1664818365.0
howdoi-2.0.20/howdoi.egg-info/PKG-INFO 0000644 0000765 0000024 00000037157 14316616275 016415 0 ustar 00gleitz staff Metadata-Version: 2.1
Name: howdoi
Version: 2.0.20
Summary: Instant coding answers via the command line
Home-page: https://github.com/gleitz/howdoi
Author: Benjamin Gleitzman
Author-email: gleitz@mit.edu
Maintainer: Benjamin Gleitzman
Maintainer-email: gleitz@mit.edu
License: MIT
Description:
howdoi
Instant coding answers via the command line
⚡ Never open your browser to look for help again ⚡
------------------------------------------------------------------------
## Introduction to howdoi
Are you a hack programmer? Do you find yourself constantly Googling for
how to do basic programming tasks?
Suppose you want to know how to format a date in bash. Why open your
browser and read through blogs (risking major distraction) when you can
simply stay in the console and ask howdoi:
$ howdoi format date bash
> DATE=`date +%Y-%m-%d`
howdoi will answer all sorts of queries:
$ howdoi print stack trace python
> import traceback
>
> try:
> 1/0
> except:
> print '>>> traceback <<<'
> traceback.print_exc()
> print '>>> end of traceback <<<'
> traceback.print_exc()
$ howdoi convert mp4 to animated gif
> video=/path/to/video.avi
> outdir=/path/to/output.gif
> mplayer "$video" \
> -ao null \
> -ss "00:01:00" \ # starting point
> -endpos 10 \ # duration in second
> -vo gif89a:fps=13:output=$outdir \
> -vf scale=240:180
$ howdoi create tar archive
> tar -cf backup.tar --exclude "www/subf3" www
[](https://xkcd.com/1168/)
## Installation
pip install howdoi
## Usage
### New to howdoi?
howdoi howdoi
### RTFM
- [Introduction and
installation](http://gleitz.github.io/howdoi/introduction/)
- [Usage](http://gleitz.github.io/howdoi/usage/)
- [Contributing to
howdoi](http://gleitz.github.io/howdoi/contributing_to_howdoi/)
- [Advanced
usage](http://gleitz.github.io/howdoi/howdoi_advanced_usage/)
- [Troubleshooting](http://gleitz.github.io/howdoi/troubleshooting/)
### Commands
usage: howdoi [-h] [-p POS] [-n NUM] [-a] [-l] [-c] [-x] [-C] [-j] [-v] [-e [ENGINE]]
[--save] [--view] [--remove] [--empty] [QUERY ...]
instant coding answers via the command line
positional arguments:
QUERY the question to answer
optional arguments:
-h, --help show this help message and exit
-p POS, --pos POS select answer in specified position (default: 1)
-n NUM, --num NUM number of answers to return (default: 1)
-a, --all display the full text of the answer
-l, --link display only the answer link
-c, --color enable colorized output
-x, --explain explain how answer was chosen
-C, --clear-cache clear the cache
-j, --json return answers in raw json format
-v, --version display the current version of howdoi
-e [ENGINE], --engine [ENGINE]
search engine for this query (google, bing, duckduckgo)
--save, --stash stash a howdoi answer
--view view your stash
--remove remove an entry in your stash
--empty empty your stash
environment variable examples:
HOWDOI_COLORIZE=1
HOWDOI_DISABLE_CACHE=1
HOWDOI_DISABLE_SSL=1
HOWDOI_SEARCH_ENGINE=google
HOWDOI_URL=serverfault.com
Using the howdoi stashing feature (for more advanced features view the
[keep documentation](https://github.com/OrkoHunter/keep)).
stashing: howdoi --save QUERY
viewing: howdoi --view
removing: howdoi --remove (will be prompted which answer to delete)
emptying: howdoi --empty (empties entire stash, will be prompted to confirm)
As a shortcut, if you commonly use the same parameters each time and
don\'t want to type them, add something similar to your .bash_profile
(or otherwise). This example gives you 5 colored results each time.
alias h='function hdi(){ howdoi $* -c -n 5; }; hdi'
And then to run it from the command line simply type:
$ h format date bash
You can also search other [StackExchange
properties](https://stackexchange.com/sites#traffic) for answers:
HOWDOI_URL=cooking.stackexchange.com howdoi make pesto
or as an alias:
alias hcook='function hcook(){ HOWDOI_URL=cooking.stackexchange.com howdoi $* ; }; hcook'
hcook make pesto
Other useful aliases:
alias hless='function hdi(){ howdoi $* -c | less --raw-control-chars --quit-if-one-screen --no-init; }; hdi'
## Contributors
- Benjamin Gleitzman ([\@gleitz](http://twitter.com/gleitz))
- Yanlam Ko ([\@YKo20010](https://github.com/YKo20010))
- Diana Arreola ([\@diarreola](https://github.com/diarreola))
- Eyitayo Ogunbiyi ([\@tayoogunbiyi](https://github.com/tayoogunbiyi))
- Chris Nguyen ([\@chrisngyn](https://github.com/chrisngyn))
- Shageldi Ovezov ([\@ovezovs](https://github.com/chrisngyn))
- Mwiza Simbeye
([\@mwizasimbeye11](https://github.com/mwizasimbeye11))
- Shantanu Verma ([\@SaurusXI](https://github.com/SaurusXI))
- Sheza Munir ([\@ShezaMunir](https://github.com/ShezaMunir))
- Jyoti Bisht ([\@joeyouss](https://github.com/joeyouss))
- And [more!](https://github.com/gleitz/howdoi/graphs/contributors)
## How to contribute
We welcome contributions that make howdoi better and improve the
existing functionalities of the project. We have created a separate
[guide to contributing to
howdoi](http://gleitz.github.io/howdoi/contributing_to_howdoi/) that explains
how to get up and running with your first pull request.
## Notes
- Works with Python 3.5 and newer. Unfortunately Python 2.7 support
has been discontinued :(
- There is a [GUI that wraps
howdoi](https://pypi.org/project/pysimplegui-howdoi/)
- There is a [Flask webapp that wraps
howdoi](https://howdoi.maxbridgland.com)
- An [Alfred Workflow](http://blog.gleitzman.com/post/48539944559/howdoi-alfred-even-more-instant-answers)
for howdoi
- Slack integration available through
[slack-howdoi](https://github.com/ellisonleao/slack-howdoi)
- Telegram integration available through
[howdoi-telegram](https://github.com/aahnik/howdoi-telegram)
- Special thanks to Rich Jones
([\@miserlou](https://github.com/miserlou)) for the idea
- More thanks to [Ben Bronstein](https://benbronstein.com/) for the
logo
## Visual Studio Code Extension Installation
Head over to the [MarketPlace](https://marketplace.visualstudio.com/items?itemName=howdoi-org.howdoi)
to install the extension.
# News
2.0.20
------
- Update dependency versions
- Add support for Python 3.10
2.0.19
------
- Fix typo
2.0.18
------
- Fixed issue with howdoi cache where cache misses would be printed to the console
2.0.17
------
- New documentation and mkdocs
- Fixed issue with how howdoi chooses the proper search engine (command line flags now override environment variables)
- Added a search engine fallback if one of the search engines fails
- Fixed issue with howdoi cache
2.0.16
------
- Fix GDPR issue for those using howdoi in countries outside the US
- Better support for using `HOWDOI_URL`
2.0.15
------
- Add explainability with `-x` or `--explain` options
- Better error checking for when search engines block queries
- Using improved DuckDuckGo endpoint
- Answer pages now fetched in parallel for speed improvement
2.0.14
------
- Fix a number of bugs by switching from parsing Google links to looking for URLs instead
2.0.13
------
- More permanent fix for extracting Google links
2.0.12
------
- Hotfix for Google link formatting
2.0.11
------
- Hotfix for Google link formatting
2.0.10
------
- Hotfix for new Google classnames
- Separate requirements.txt files for prod and dev
2.0.9
------
- Cleaner command line options that also include environment variables
- README updates
2.0.8
------
- Fix issue for answers that have no code in the answer but code in the comments
- Add range checks for -n and -p flags
- Moved from Travis to Github Actions
- Dropped Python 2.7 support
2.0.7
------
- Update for new Google CSS style
2.0.6
------
- Fix issue where `-a` would not return a proper response due to updated CSS on StackOverflow
2.0.5
------
- New logo and colors!
2.0.4
------
- Cachelib rollback to support Python 2.7
- Better error message when Google is being blocked (for example in China)
2.0.3
------
- Bring back Python 2.7 support (for now)
2.0.2
------
- Fixed keep support for stashing and viewing answers
2.0.1
------
- Added JSON output with the -j flag (great for consuming howdoi results for use in other apps)
- Added stashing ability for saving useful answer for later (based on https://github.com/OrkoHunter/keep)
- Added caching for tests to prevent being rate limited by Google while developing
- Added easier method for calling howdoi when imported (howdoi.howdoi)
1.2.1
------
- Fix dependency issue
1.2.0
------
- Massive speed improvements of startup, answer fetching, and caching
- Command line flags for alternate search engines
- Remove duplicate answers
1.1.14
------
- Links displayed with markdown syntax
- Improved performance and caching (again)
1.1.13
------
- Improved performance and caching
- More friendly answer display
- Added support for Python 3.6
- Removed support for Python 2.6
1.1.12
------
- Add additional search engine support
1.1.11
------
- Fix issue with UTF-8 encoding
1.1.10
------
- Include the link in output when asking for >1 answer
- Compatibility with linuxbrew
1.1.9
------
- Fix issue with upload to PyPI
1.1.8
------
- Fix colorization when HOWDOI_COLORIZE env variable is enabled
- Fix certificate validation when SSL disabled
1.1.7
------
- Add Localization support with HOWDOI_LOCALIZATION env variable (Currently only pt-br and en)
1.1.6
------
- Updates for Python3
- Updates for caching
1.1.5
------
- Updates for Python3
- Fix issues with cache
- Allow disabling SSL when accessing Google
1.1.4
------
- Added caching
1.1.3
------
- Added fix to handle change in Google search page HTML
- Updated Travis CI tests
1.1.2
------
- Compatibility fixes for Python3.2
- Travis CI tests now being run for Python 2.6, 2.7, 3.2, and 3.3
1.1.1
------
- Added message when question has no answer
1.1
------
- Added multiple answers with -n/--num-answers flag
- Added colorized output with -c/--color flag
- Added answer link to the bottom of questions with -a/--all flag
- Unit tests now managed through Travis CI
1.0
------
- Added support for Python3
- Switched to the requests library instead of urllib2
- Project status changed to Production/Stable
- Added troubleshooting steps to the README
0.2
------
- Added sane flags
- Now using ``/usr/bin/env python`` instead of ``/usr/bin/python``
- Updated README for brew installation instructions
0.1.2
------
- Added Windows executable
- Updated README for pip installation instructions
0.1.1
------
- Added to PyPI
0.1
------
- We're doing it live!
Keywords: howdoi help console command line answer
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Documentation
Description-Content-Type: text/markdown
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1664818365.0
howdoi-2.0.20/howdoi.egg-info/SOURCES.txt 0000644 0000765 0000024 00000000547 14316616275 017175 0 ustar 00gleitz staff CHANGES.txt
LICENSE.txt
MANIFEST.in
README.md
fastentrypoints.py
requirements.txt
setup.py
test_howdoi.py
howdoi/__init__.py
howdoi/__main__.py
howdoi/errors.py
howdoi/howdoi.py
howdoi.egg-info/PKG-INFO
howdoi.egg-info/SOURCES.txt
howdoi.egg-info/dependency_links.txt
howdoi.egg-info/entry_points.txt
howdoi.egg-info/requires.txt
howdoi.egg-info/top_level.txt ././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1664818365.0
howdoi-2.0.20/howdoi.egg-info/dependency_links.txt 0000644 0000765 0000024 00000000001 14316616275 021351 0 ustar 00gleitz staff
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1664818365.0
howdoi-2.0.20/howdoi.egg-info/entry_points.txt 0000644 0000765 0000024 00000000076 14316616275 020604 0 ustar 00gleitz staff [console_scripts]
howdoi = howdoi.howdoi:command_line_runner
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1664818365.0
howdoi-2.0.20/howdoi.egg-info/requires.txt 0000644 0000765 0000024 00000000115 14316616275 017700 0 ustar 00gleitz staff Pygments
cssselect
lxml
pyquery
requests
cachelib
appdirs
keep
rich
colorama
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1664818365.0
howdoi-2.0.20/howdoi.egg-info/top_level.txt 0000644 0000765 0000024 00000000007 14316616275 020032 0 ustar 00gleitz staff howdoi
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1627661451.0
howdoi-2.0.20/requirements.txt 0000644 0000765 0000024 00000000142 14101022213 015550 0 ustar 00gleitz staff # when adding a new dependency, also add to setup.py's `install_requires`
-r requirements/prod.txt ././@PaxHeader 0000000 0000000 0000000 00000000034 00000000000 010212 x ustar 00 28 mtime=1664818366.1108494
howdoi-2.0.20/setup.cfg 0000644 0000765 0000024 00000000046 14316616276 014142 0 ustar 00gleitz staff [egg_info]
tag_build =
tag_date = 0
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1664817974.0
howdoi-2.0.20/setup.py 0000644 0000765 0000024 00000006070 14316615466 014036 0 ustar 00gleitz staff #!/usr/bin/env python
import glob
import subprocess
from pathlib import Path
from distutils.cmd import Command # pylint: disable=deprecated-module
from setuptools import setup, find_packages
# pylint: disable=unused-import
import fastentrypoints # noqa: F401
# pylint: enable=unused-import
import howdoi
class Lint(Command):
"""A custom command to run Flake8 on all Python source files.
"""
description = 'run Flake8 on Python source files'
user_options = []
def initialize_options(self):
pass
def finalize_options(self):
pass
def run(self):
local_python_files_str = ' '.join(glob.glob('*.py'))
commands = {'Flake8': 'flake8 --config=.flake8rc .'.split(),
'Pylint': f'pylint howdoi {local_python_files_str} --rcfile=.pylintrc'.split()}
for linter, command in commands.items():
try:
print(f'\nRunning {linter}...')
subprocess.check_call(command)
print(f'No lint errors found by {linter}')
except FileNotFoundError:
print(f'{linter} not installed')
except subprocess.CalledProcessError:
pass
def read(*names):
values = {}
for name in names:
value = ''
for extension in ('.txt', '.md'):
filename = name + extension
if Path(filename).is_file():
with open(filename, encoding='utf-8') as in_file:
value = in_file.read()
break
values[name] = value
return values
# pylint: disable=consider-using-f-string
long_description = """
%(README)s
# News
%(CHANGES)s
""" % read('README', 'CHANGES')
# pylint: enable=consider-using-f-string
setup(
name='howdoi',
version=howdoi.__version__,
description='Instant coding answers via the command line',
long_description=long_description,
long_description_content_type='text/markdown',
classifiers=[
"Development Status :: 5 - Production/Stable",
"Environment :: Console",
"Intended Audience :: Developers",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Topic :: Documentation",
],
keywords='howdoi help console command line answer',
author='Benjamin Gleitzman',
author_email='gleitz@mit.edu',
maintainer='Benjamin Gleitzman',
maintainer_email='gleitz@mit.edu',
url='https://github.com/gleitz/howdoi',
license='MIT',
packages=find_packages(),
entry_points={
'console_scripts': [
'howdoi = howdoi.howdoi:command_line_runner',
]
},
install_requires=[
'Pygments',
'cssselect',
'lxml',
'pyquery',
'requests',
'cachelib',
'appdirs',
'keep',
'rich',
'colorama'
],
cmdclass={
'lint': Lint
}
)
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1664817974.0
howdoi-2.0.20/test_howdoi.py 0000644 0000765 0000024 00000040230 14316615466 015222 0 ustar 00gleitz staff #!/usr/bin/env python
"""Tests for Howdoi."""
import gzip
import json
import os
import re
import unittest
from pathlib import Path
from unittest.mock import patch
import requests
from cachelib import NullCache
from pyquery import PyQuery as pq
# pylint: disable=no-name-in-module
from howdoi import howdoi
# pylint: disable=protected-access
original_get_result = howdoi._get_result
def _format_url_to_filename(url, file_ext='html'):
filename = ''.join(ch for ch in url if ch.isalnum())
return filename + '.' + file_ext
def _get_result_mock(url):
# pylint: disable=protected-access
file_name = _format_url_to_filename(url, 'html.gz')
# pylint: disable=no-member
file_path = Path.joinpath(Path(howdoi.HTML_CACHE_PATH), Path(file_name)).resolve()
try:
with gzip.open(file_path, 'rb') as f:
cached_page_content = str(f.read(), encoding='utf-8')
return cached_page_content
except FileNotFoundError:
page_content = original_get_result(url)
with gzip.open(file_path, 'wb') as f:
f.write(bytes(page_content, encoding='utf-8'))
return page_content
# pylint: disable=protected-access
class HowdoiTestCase(unittest.TestCase): # pylint: disable=too-many-public-methods
def setUp(self):
self.patcher_get_result = patch.object(howdoi, '_get_result')
self.mock_get_result = self.patcher_get_result.start()
self.mock_get_result.side_effect = _get_result_mock
# ensure no cache is used during testing.
howdoi.cache = NullCache()
self.queries = ['format date bash',
'print stack trace python',
'convert mp4 to animated gif',
'create tar archive',
'cat']
self.help_queries = howdoi.SUPPORTED_HELP_QUERIES
self.pt_queries = ['abrir arquivo em python',
'enviar email em django',
'hello world em c']
self.bad_queries = ['moe',
'mel']
self.query_without_code_or_pre_block = 'Difference between element node and Text Node'
def tearDown(self):
self.patcher_get_result.stop()
keys_to_remove = ['HOWDOI_URL', 'HOWDOI_SEARCH_ENGINE']
for key in keys_to_remove:
if key in os.environ:
del os.environ[key]
howdoi.BLOCKED_ENGINES = []
def _negative_number_query(self):
query = self.queries[0]
howdoi.howdoi(query + ' -n -1')
def _high_positive_number_query(self):
query = self.queries[0]
howdoi.howdoi(query + ' -n 21')
def _negative_position_query(self):
query = self.queries[0]
howdoi.howdoi(query + ' -p -2')
def _high_positive_position_query(self):
query = self.queries[0]
howdoi.howdoi(query + ' -p 40')
def assertValidResponse(self, res): # pylint: disable=invalid-name
self.assertTrue(len(res) > 0)
def test_get_link_at_pos(self):
self.assertEqual(howdoi.get_link_at_pos(['/questions/42/'], 1),
'/questions/42/')
self.assertEqual(howdoi.get_link_at_pos(['/questions/42/'], 2),
'/questions/42/')
self.assertEqual(howdoi.get_link_at_pos(['/howdoi', '/questions/42/'], 1),
'/howdoi')
self.assertEqual(howdoi.get_link_at_pos(['/howdoi', '/questions/42/'], 2),
'/questions/42/')
self.assertEqual(howdoi.get_link_at_pos(['/questions/42/', '/questions/142/'], 1),
'/questions/42/')
@patch.object(howdoi, '_get_result')
def test_blockerror(self, mock_get_links):
mock_get_links.side_effect = requests.HTTPError
query = self.queries[0]
response = howdoi.howdoi(query)
self.assertEqual(response, "ERROR: \x1b[91mUnable to get a response from any search engine\n\x1b[0m")
def test_answers(self):
for query in self.queries:
self.assertValidResponse(howdoi.howdoi(query))
for query in self.bad_queries:
self.assertValidResponse(howdoi.howdoi(query))
os.environ['HOWDOI_URL'] = 'pt.stackoverflow.com'
for query in self.pt_queries:
self.assertValidResponse(howdoi.howdoi(query))
def test_answers_bing(self):
os.environ['HOWDOI_SEARCH_ENGINE'] = 'bing'
for query in self.queries:
self.assertValidResponse(howdoi.howdoi(query))
for query in self.bad_queries:
self.assertValidResponse(howdoi.howdoi(query))
os.environ['HOWDOI_URL'] = 'pt.stackoverflow.com'
for query in self.pt_queries:
self.assertValidResponse(howdoi.howdoi(query))
os.environ['HOWDOI_SEARCH_ENGINE'] = ''
# commenting out duckduckgo test, re-enable when issue #404 (duckduckgo blocking requests) is resolved
# def test_answers_duckduckgo(self):
# os.environ['HOWDOI_SEARCH_ENGINE'] = 'duckduckgo'
# for query in self.queries:
# self.assertValidResponse(howdoi.howdoi(query))
# for query in self.bad_queries:
# self.assertValidResponse(howdoi.howdoi(query))
# os.environ['HOWDOI_URL'] = 'pt.stackoverflow.com'
# for query in self.pt_queries:
# self.assertValidResponse(howdoi.howdoi(query))
# os.environ['HOWDOI_SEARCH_ENGINE'] = ''
def test_answer_links_using_l_option(self):
for query in self.queries:
response = howdoi.howdoi(query + ' -l')
self.assertNotEqual(re.match(r'http.?://.*questions/\d.*', response, re.DOTALL), None)
def test_answer_links_using_all_option(self):
for query in self.queries:
response = howdoi.howdoi(query + ' -a')
self.assertNotEqual(re.match(r'.*http.?://.*questions/\d.*', response, re.DOTALL), None)
def test_position(self):
query = self.queries[0]
first_answer = howdoi.howdoi(query)
not_first_answer = howdoi.howdoi(query + ' -p5')
self.assertNotEqual(first_answer, not_first_answer)
def test_all_text(self):
query = self.queries[0]
first_answer = howdoi.howdoi(query)
second_answer = howdoi.howdoi(query + ' -a')
self.assertNotEqual(first_answer, second_answer)
self.assertNotEqual(re.match('.*Answer from http.?://.*', second_answer, re.DOTALL), None)
def test_json_output(self):
query = self.queries[0]
txt_answer = howdoi.howdoi(query)
json_answer = howdoi.howdoi(query + ' -j')
link_answer = howdoi.howdoi(query + ' -l')
json_answer = json.loads(json_answer)[0]
self.assertEqual(json_answer["answer"], txt_answer)
self.assertEqual(json_answer["link"], link_answer)
self.assertEqual(json_answer["position"], 1)
def test_multiple_answers(self):
query = self.queries[0]
first_answer = howdoi.howdoi(query)
second_answer = howdoi.howdoi(query + ' -n3')
self.assertNotEqual(first_answer, second_answer)
def test_unicode_answer(self): # pylint: disable=no-self-use
assert howdoi.howdoi('make a log scale d3')
assert howdoi.howdoi('python unittest -n3')
assert howdoi.howdoi('parse html regex -a')
assert howdoi.howdoi('delete remote git branch -a')
def test_colorize(self):
query = self.queries[0]
normal = howdoi.howdoi(query)
colorized = howdoi.howdoi('-c ' + query)
# There is currently an issue with Github actions and colorization
# so do not run checks if we are running in Github
if "GITHUB_ACTION" not in os.environ:
self.assertTrue(normal.find('[38;') == -1)
self.assertTrue(colorized.find('[38;') != -1)
# pylint: disable=line-too-long
def test_get_text_without_links(self):
html = '''\n The halting problem is basically a\n formal way of asking if you can tell\n whether or not an arbitrary program\n will eventually halt.
\n \n In other words, can you write a\n program called a halting oracle,\n HaltingOracle(program, input), which\n returns true if program(input) would\n eventually halt, and which returns\n false if it wouldn't?
\n \n The answer is: no, you can't.
\n''' # noqa: E501
paragraph = pq(html)
expected_output = '''The halting problem is basically a\n formal way of asking if you can tell\n whether or not an arbitrary program\n will eventually halt.\n\n \n \nIn other words, can you write a\n program called a halting oracle,\n HaltingOracle(program, input), which\n returns true if program(input) would\n eventually halt, and which returns\n false if it wouldn't?\n\n \n \nThe answer is: no, you can't.\n\n''' # noqa: E501
actual_output = howdoi.get_text(paragraph)
self.assertEqual(actual_output, expected_output)
def test_get_text_with_one_link(self):
html = 'It\'s a protocol-relative URL (typically HTTP or HTTPS). So if I\'m on http://example.org and I link (or include an image, script, etc.) to //example.com/1.png, it goes to http://example.com/1.png. If I\'m on https://example.org, it goes to https://example.com/1.png.
' # noqa: E501
paragraph = pq(html)
expected_output = "It's a [protocol-relative URL](http://paulirish.com/2010/the-protocol-relative-url/) (typically HTTP or HTTPS). So if I'm on http://example.org and I link (or include an image, script, etc.) to //example.com/1.png, it goes to http://example.com/1.png. If I'm on https://example.org, it goes to https://example.com/1.png." # noqa: E501
actual_output = howdoi.get_text(paragraph)
self.assertEqual(actual_output, expected_output)
def test_get_text_with_multiple_links_test_one(self):
html = 'Here\'s a quote from wikipedia\'s manual of style section on links (but see also their comprehensive page on External Links)' # noqa: E501
paragraph = pq(html)
expected_output = "Here's a quote from [wikipedia's manual of style](http://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style#Links) section on links (but see also [their comprehensive page on External Links](http://en.wikipedia.org/wiki/Wikipedia:External_links))" # noqa: E501
actual_output = howdoi.get_text(paragraph)
self.assertEqual(actual_output, expected_output)
def test_get_text_with_multiple_links_test_two(self):
html = 'For example, if I were to reference apple.com as the subject of a sentence - or to talk about Apple\'s website as the topic of conversation. This being different to perhaps recommendations for reading our article about Apple\'s website.' # noqa: E501
paragraph = pq(html)
expected_output = "For example, if I were to reference [apple.com](http://www.apple.com/) as the subject of a sentence - or to talk about [Apple's website](http://www.apple.com/) as the topic of conversation. This being different to perhaps recommendations for reading [our article about Apple's website](https://ux.stackexchange.com/q/14872/6046)." # noqa: E501
actual_output = howdoi.get_text(paragraph)
self.assertEqual(actual_output, expected_output)
def test_get_text_with_link_but_with_copy_duplicating_the_href(self):
html = 'https://github.com/jquery/jquery/blob/56136897f241db22560b58c3518578ca1453d5c7/src/manipulation.js#L451' # noqa: E501
paragraph = pq(html)
expected_output = 'https://github.com/jquery/jquery/blob/56136897f241db22560b58c3518578ca1453d5c7/src/manipulation.js#L451' # noqa: E501
actual_output = howdoi.get_text(paragraph)
self.assertEqual(actual_output, expected_output)
def test_get_text_with_a_link_but_copy_is_within_nested_div(self):
html = 'If the function is from a source file available on the filesystem, then inspect.getsource(foo) might be of help:' # noqa: E501
paragraph = pq(html)
expected_output = 'If the function is from a source file available on the filesystem, then [inspect.getsource(foo)](https://docs.python.org/3/library/inspect.html#inspect.getsource) might be of help:' # noqa: E501
actual_output = howdoi.get_text(paragraph)
self.assertEqual(actual_output, expected_output)
# pylint: enable=line-too-long
def test_get_questions(self):
links = ['https://stackoverflow.com/questions/tagged/cat',
'http://rads.stackoverflow.com/amzn/click/B007KAZ166',
'https://stackoverflow.com/questions/40108569/how-to-get-the-last-line-of-a-file-using-cat-command']
expected_output = [
'https://stackoverflow.com/questions/40108569/how-to-get-the-last-line-of-a-file-using-cat-command']
actual_output = howdoi._get_questions(links)
self.assertSequenceEqual(actual_output, expected_output)
def test_help_queries(self):
help_queries = self.help_queries
for query in help_queries:
output = howdoi.howdoi(query)
self.assertTrue(output)
self.assertIn('few popular howdoi commands', output)
self.assertIn('retrieve n number of answers', output)
self.assertIn(
'Specify the search engine you want to use e.g google,bing',
output
)
def test_missing_pre_or_code_query(self):
output = howdoi.howdoi(self.query_without_code_or_pre_block)
self.assertTrue(output)
self.assertIn('XML elements present in a XML', output)
def test_format_url_to_filename(self):
url = 'https://stackoverflow.com/questions/tagged/cat'
invalid_filename_characters = ['/', '\\', '%']
filename = _format_url_to_filename(url, 'html')
self.assertTrue(filename)
self.assertTrue(filename.endswith('html'))
for invalid_character in invalid_filename_characters:
self.assertNotIn(invalid_character, filename)
def test_help_queries_are_properly_validated(self):
help_queries = self.help_queries
for query in help_queries:
is_valid_help_query = howdoi._is_help_query(query)
self.assertTrue(is_valid_help_query)
bad_help_queries = [self.queries[0],
self.bad_queries[0], 'use how do i']
for query in bad_help_queries:
self.assertFalse(howdoi._is_help_query(query))
def test_negative_and_high_positive_int_values_rejected(self):
with self.assertRaises(SystemExit):
self._negative_number_query()
with self.assertRaises(SystemExit):
self._negative_position_query()
with self.assertRaises(SystemExit):
self._high_positive_position_query()
with self.assertRaises(SystemExit):
self._high_positive_number_query()
class HowdoiTestCaseEnvProxies(unittest.TestCase):
def setUp(self):
self.temp_get_proxies = howdoi.getproxies
def tearDown(self):
howdoi.getproxies = self.temp_get_proxies
def test_get_proxies1(self):
def getproxies1():
proxies = {'http': 'wwwproxy.company.com',
'https': 'wwwproxy.company.com',
'ftp': 'ftpproxy.company.com'}
return proxies
howdoi.getproxies = getproxies1
filtered_proxies = howdoi.get_proxies()
self.assertTrue('http://' in filtered_proxies['http'])
self.assertTrue('http://' in filtered_proxies['https'])
self.assertTrue('ftp' not in filtered_proxies.keys()) # pylint: disable=consider-iterating-dictionary
if __name__ == '__main__':
unittest.main()