Skip to content

Commit

Permalink
🔖 Alpha version (#10)
Browse files Browse the repository at this point in the history 
* 🔖 Alpha version

- 🔨 Refactor
- ✨ Make url parameter optional

* Fix lint

* Fix lint for windows
  • Loading branch information
@roniemartinez
roniemartinez authored Apr 21, 2022
1 parent c49ddea commit a74ea94
Show file tree
Hide file tree
Showing 8 changed files with 287 additions and 188 deletions.
49 changes: 44 additions & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,13 +41,52 @@ pip install pybrowsers

## Usage

### Python
### Import

```python
>>> import browsers
>>> browsers.get("chrome")
{'path': '/Applications/Google Chrome.app', 'display_name': 'Google Chrome', 'version': '100.0.4896.88'}
>>> browsers.launch("chrome", url="https://github.com/roniemartinez/browsers")
import browsers
```

### List all installer browsers

```python
import browsers

print(list(browsers.browsers()))
# [('chrome', {'path': '/Applications/Google Chrome.app', 'display_name': 'Google Chrome', 'version': '100.0.4896.127'}), ('firefox', {'path': '/Applications/Firefox.app', 'display_name': 'Firefox', 'version': '99.0.1'}), ('safari', {'path': '/Applications/Safari.app', 'display_name': 'Safari', 'version': '15.4'}), ('opera', {'path': '/Applications/Opera.app', 'display_name': 'Opera', 'version': '85.0.4341.60'}), ('msedge', {'path': '/Applications/Microsoft Edge.app', 'display_name': 'Microsoft Edge', 'version': '100.1185.22041544'})]
```

### Get browser information

```python
import browsers

print(browsers.get("chrome"))
# {'path': '/Applications/Google Chrome.app', 'display_name': 'Google Chrome', 'version': '100.0.4896.88'}
```

### Launch browser

```python
import browsers

browsers.launch("chrome")
```

### Launch browser with URL

```python
import browsers

browsers.launch("chrome", url="https://github.com/roniemartinez/browsers")
```

### Launch browser with arguments

```python
import browsers

browsers.launch("chrome", args=["--incognito"])
```

## TODO:
Expand Down
187 changes: 42 additions & 145 deletions browsers/__init__.py
View file
Original file line number Diff line number Diff line change
@@ -1,110 +1,29 @@
import logging
import os
import plistlib
import shlex
import subprocess
import sys
from typing import Dict, Iterator, Optional, Sequence, Tuple

from . import linux, osx, windows

__all__ = ["browsers", "get", "launch"]

logging.basicConfig(stream=sys.stdout, level=logging.INFO, format="%(asctime)s %(levelname)s %(message)s")
logger = logging.getLogger(__name__)

OSX_BROWSER_BUNDLE_LIST = (
# browser name, bundle ID, version string
("chrome", "com.google.Chrome", "KSVersion"),
("chrome-canary", "com.google.Chrome.canary", "KSVersion"),
("chromium", "org.chromium.Chromium", "CFBundleShortVersionString"),
("firefox", "org.mozilla.firefox", "CFBundleShortVersionString"),
("firefox-developer", "org.mozilla.firefoxdeveloperedition", "CFBundleShortVersionString"),
("firefox-nightly", "org.mozilla.nightly", "CFBundleShortVersionString"),
("safari", "com.apple.Safari", "CFBundleShortVersionString"),
("opera", "com.operasoftware.Opera", "CFBundleVersion"),
("opera-beta", "com.operasoftware.OperaNext", "CFBundleVersion"),
("opera-developer", "com.operasoftware.OperaDeveloper", "CFBundleVersion"),
("msedge", "com.microsoft.edgemac", "CFBundleVersion"),
("msedge-beta", "com.microsoft.edgemac.Beta", "CFBundleVersion"),
("msedge-dev", "com.microsoft.edgemac.Dev", "CFBundleVersion"),
("msedge-canary", "com.microsoft.edgemac.Canary", "CFBundleVersion"),
("brave", "com.brave.Browser", "CFBundleVersion"),
("brave-beta", "com.brave.Browser.beta", "CFBundleVersion"),
("brave-dev", "com.brave.Browser.dev", "CFBundleVersion"),
("brave-nightly", "com.brave.Browser.nightly", "CFBundleVersion"),
)

LINUX_DESKTOP_ENTRY_LIST = (
("chrome", ("google-chrome",)),
("chromium", ("chromium", "chromium_chromium")),
("firefox", ("firefox", "firefox_firefox")),
("msedge", ("microsoft-edge",)),
("opera", ("opera_opera",)),
("opera-beta", ("opera-beta_opera-beta",)),
("opera-developer", ("opera-developer_opera-developer",)),
("brave", ("brave-browser", "brave_brave")),
("brave-beta", ("brave-browser-beta",)),
("brave-nightly", ("brave-browser-nightly",)),
)

# $XDG_DATA_HOME and $XDG_DATA_DIRS are not always set
XDG_DATA_LOCATIONS = (
"~/.local/share/applications",
"/usr/share/applications",
"/var/lib/snapd/desktop/applications",
)

WINDOWS_REGISTRY_BROWSER_NAMES = {
"Google Chrome": "chrome",
"Google Chrome Canary": "chrome-canary",
"Mozilla Firefox": "firefox",
"Firefox Developer Edition": "firefox-developer",
"Firefox Nightly": "firefox-nightly",
"Opera Stable": "opera",
"Opera beta": "opera-beta",
"Opera developer": "opera-developer",
"Microsoft Edge": "msedge",
"Microsoft Edge Beta": "msedge-beta",
"Microsoft Edge Dev": "msedge-dev",
"Microsoft Edge Canary": "msedge-canary",
"Internet Explorer": "msie",
"Brave": "brave",
"Brave Beta": "brave-beta",
"Brave Nightly": "brave-nightly",
}


def get_available_browsers() -> Iterator[Tuple[str, Dict]]:

def browsers() -> Iterator[Tuple[str, Dict]]:
"""
Iterates over installed browsers.
:return: Iterator of Tuple of browser key and browser information.
"""
if sys.platform == "linux":
from xdg.DesktopEntry import DesktopEntry

for browser, desktop_entries in LINUX_DESKTOP_ENTRY_LIST:
for application_dir in XDG_DATA_LOCATIONS:
# desktop entry name can be "firefox.desktop" or "firefox_firefox.desktop"
for desktop_entry in desktop_entries:
path = os.path.join(application_dir, f"{desktop_entry}.desktop")
if not os.path.isfile(path):
continue
entry = DesktopEntry(path)
executable_path = entry.getExec()
if executable_path.lower().endswith(" %u"):
executable_path = executable_path[:-3].strip()
# FIXME: --version includes the name for most browsers
version = subprocess.getoutput(f"{executable_path} --version")
info = dict(path=executable_path, display_name=entry.getName(), version=version)
yield browser, info
yield from linux.browsers()
elif sys.platform == "win32":
import winreg

yield from get_browsers_from_registry(winreg.HKEY_CURRENT_USER, winreg.KEY_READ)
yield from get_browsers_from_registry(winreg.HKEY_LOCAL_MACHINE, winreg.KEY_READ | winreg.KEY_WOW64_64KEY)
yield from get_browsers_from_registry(winreg.HKEY_LOCAL_MACHINE, winreg.KEY_READ | winreg.KEY_WOW64_32KEY)
yield from windows.browsers()
elif sys.platform == "darwin":
for browser, bundle_id, version_string in OSX_BROWSER_BUNDLE_LIST:
paths = subprocess.getoutput(f'mdfind "kMDItemCFBundleIdentifier == {bundle_id}"').splitlines()
for path in paths:
with open(os.path.join(path, "Contents/Info.plist"), "rb") as f:
plist = plistlib.load(f)
display_name = plist.get("CFBundleDisplayName") or plist.get("CFBundleName", browser)
version = plist[version_string]
yield browser, dict(path=path, display_name=display_name, version=version)
yield from osx.browsers()
else: # pragma: no cover
logger.info(
"'%s' is currently not supported. Please open an issue or a PR at '%s'",
Expand All @@ -113,74 +32,52 @@ def get_available_browsers() -> Iterator[Tuple[str, Dict]]:
)


def get_browsers_from_registry(tree: int, access: int) -> Iterator[Tuple[str, Dict]]: # type: ignore[return]
if sys.platform == "win32":
import winreg

key = r"Software\Clients\StartMenuInternet"
try:
with winreg.OpenKey(tree, key, access=access) as hkey:
i = 0
while True:
try:
subkey = winreg.EnumKey(hkey, i)
i += 1
except OSError:
break
try:
name = winreg.QueryValue(hkey, subkey)
if not name or not isinstance(name, str):
name = subkey
except OSError:
name = subkey
try:
cmd = winreg.QueryValue(hkey, rf"{subkey}\shell\open\command")
cmd = cmd.strip('"')
os.stat(cmd)
except (OSError, AttributeError, TypeError, ValueError):
continue
info = dict(path=cmd, display_name=name, version=get_file_version(cmd))
yield WINDOWS_REGISTRY_BROWSER_NAMES.get(name, "unknown"), info
except FileNotFoundError:
pass


def get_file_version(path: str) -> Optional[str]:
if sys.platform == "win32":
import win32api

info = win32api.GetFileVersionInfo(path, "\\")
ms = info["FileVersionMS"]
ls = info["FileVersionLS"]
return ".".join(map(str, (win32api.HIWORD(ms), win32api.LOWORD(ms), win32api.HIWORD(ls), win32api.LOWORD(ls))))
return None


def get(browser: str) -> Optional[Dict]:
for key, value in get_available_browsers():
"""
Returns the information for the provided browser key.
:param browser: Any of "chrome", "chrome-canary", "firefox", "firefox-developer", "firefox-nightly", "opera",
"opera-beta", "opera-developer", "msedge", "msedge-beta", "msedge-dev", "msedge-canary", "msie",
"brave", "brave-beta", "brave-dev", "brave-nightly", and "safari".
:return: Dictionary containing "path", "display_name" and "version".
"""
for key, value in browsers():
if key == browser:
return value
return None


def launch(browser: str, url: str, args: Optional[Sequence[str]] = None) -> None:
def launch(browser: str, url: str = None, args: Optional[Sequence[str]] = None) -> None:
"""
Launches a web browser.
:param browser: Browser key.
:param url: URL.
:param args: Arguments to be passed to the browser.
"""
if args is None:
args = []
b = get(browser)
if not b:
logger.info("Cannot find browser '%s'", browser)
return
_launch(browser, b["path"], url, args)
_launch(browser, b["path"], args, url)


def _launch(browser: str, path: str, args: Sequence[str], url: str = None) -> None: # pragma: no cover
url_arg = []

def _launch(browser: str, path: str, url: str, args: Sequence[str]) -> None: # pragma: no cover
url_arg = [] if browser == "firefox" else [url]
if browser == "firefox":
if browser == "firefox" and url is not None:
args = ("-new-tab", url, *args)
if sys.platform == "win32":
elif url is not None:
url_arg.append(url)

if sys.platform != "linux":
command = [path, *url_arg, "--args", *args]
else:
command = [*shlex.split(path), *url_arg, "--args", *args]

if sys.platform == "darwin":
command = ["open", "--wait-apps", "--new", "--fresh", "-a", *command]

subprocess.Popen(command)
45 changes: 45 additions & 0 deletions browsers/linux.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
import os
import subprocess
import sys
from typing import Dict, Iterator, Tuple

LINUX_DESKTOP_ENTRY_LIST = (
# desktop entry name can be "firefox.desktop" or "firefox_firefox.desktop"
("chrome", ("google-chrome",)),
("chromium", ("chromium", "chromium_chromium")),
("firefox", ("firefox", "firefox_firefox")),
("msedge", ("microsoft-edge",)),
("opera", ("opera_opera",)),
("opera-beta", ("opera-beta_opera-beta",)),
("opera-developer", ("opera-developer_opera-developer",)),
("brave", ("brave-browser", "brave_brave")),
("brave-beta", ("brave-browser-beta",)),
("brave-nightly", ("brave-browser-nightly",)),
)

# $XDG_DATA_HOME and $XDG_DATA_DIRS are not always set
XDG_DATA_LOCATIONS = (
"~/.local/share/applications",
"/usr/share/applications",
"/var/lib/snapd/desktop/applications",
)


def browsers() -> Iterator[Tuple[str, Dict]]: # type: ignore[return]
if sys.platform == "linux":
from xdg.DesktopEntry import DesktopEntry

for browser, desktop_entries in LINUX_DESKTOP_ENTRY_LIST:
for application_dir in XDG_DATA_LOCATIONS:
for desktop_entry in desktop_entries:
path = os.path.join(application_dir, f"{desktop_entry}.desktop")
if not os.path.isfile(path):
continue
entry = DesktopEntry(path)
executable_path = entry.getExec()
if executable_path.lower().endswith(" %u"):
executable_path = executable_path[:-3].strip()
# FIXME: --version includes the name for most browsers
version = subprocess.getoutput(f"{executable_path} --version")
info = dict(path=executable_path, display_name=entry.getName(), version=version)
yield browser, info
39 changes: 39 additions & 0 deletions browsers/osx.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import os
import plistlib
import subprocess
import sys
from typing import Dict, Iterator, Tuple

OSX_BROWSER_BUNDLE_LIST = (
# browser name, bundle ID, version string
("chrome", "com.google.Chrome", "KSVersion"),
("chrome-canary", "com.google.Chrome.canary", "KSVersion"),
("chromium", "org.chromium.Chromium", "CFBundleShortVersionString"),
("firefox", "org.mozilla.firefox", "CFBundleShortVersionString"),
("firefox-developer", "org.mozilla.firefoxdeveloperedition", "CFBundleShortVersionString"),
("firefox-nightly", "org.mozilla.nightly", "CFBundleShortVersionString"),
("safari", "com.apple.Safari", "CFBundleShortVersionString"),
("opera", "com.operasoftware.Opera", "CFBundleVersion"),
("opera-beta", "com.operasoftware.OperaNext", "CFBundleVersion"),
("opera-developer", "com.operasoftware.OperaDeveloper", "CFBundleVersion"),
("msedge", "com.microsoft.edgemac", "CFBundleVersion"),
("msedge-beta", "com.microsoft.edgemac.Beta", "CFBundleVersion"),
("msedge-dev", "com.microsoft.edgemac.Dev", "CFBundleVersion"),
("msedge-canary", "com.microsoft.edgemac.Canary", "CFBundleVersion"),
("brave", "com.brave.Browser", "CFBundleVersion"),
("brave-beta", "com.brave.Browser.beta", "CFBundleVersion"),
("brave-dev", "com.brave.Browser.dev", "CFBundleVersion"),
("brave-nightly", "com.brave.Browser.nightly", "CFBundleVersion"),
)


def browsers() -> Iterator[Tuple[str, Dict]]: # type: ignore[return]
if sys.platform == "darwin":
for browser, bundle_id, version_string in OSX_BROWSER_BUNDLE_LIST:
paths = subprocess.getoutput(f'mdfind "kMDItemCFBundleIdentifier == {bundle_id}"').splitlines()
for path in paths:
with open(os.path.join(path, "Contents/Info.plist"), "rb") as f:
plist = plistlib.load(f)
display_name = plist.get("CFBundleDisplayName") or plist.get("CFBundleName", browser)
version = plist[version_string]
yield browser, dict(path=path, display_name=display_name, version=version)
Loading

0 comments on commit a74ea94

Please sign in to comment.