Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Check dependencies on setup in the nicer way. (#5989)
Browse files Browse the repository at this point in the history
  • Loading branch information
anoadragon453 committed Feb 25, 2020
2 parents 136caf4 + 6604b64 commit c5d6fcc
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 28 deletions.
1 change: 1 addition & 0 deletions changelog.d/5989.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clean up dependency checking at setup.
12 changes: 5 additions & 7 deletions synapse/config/metrics.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,9 @@

import attr

from ._base import Config, ConfigError
from synapse.python_dependencies import DependencyException, check_requirements

MISSING_SENTRY = """Missing sentry-sdk library. This is required to enable sentry
integration.
"""
from ._base import Config, ConfigError


@attr.s
Expand Down Expand Up @@ -51,9 +49,9 @@ def read_config(self, config, **kwargs):
self.sentry_enabled = "sentry" in config
if self.sentry_enabled:
try:
import sentry_sdk # noqa F401
except ImportError:
raise ConfigError(MISSING_SENTRY)
check_requirements("sentry")
except DependencyException as e:
raise ConfigError(e.message)

self.sentry_dsn = config["sentry"].get("dsn")
if not self.sentry_dsn:
Expand Down
27 changes: 7 additions & 20 deletions synapse/config/repository.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import os
from collections import namedtuple

from synapse.python_dependencies import DependencyException, check_requirements
from synapse.util.module_loader import load_module

from ._base import Config, ConfigError
Expand All @@ -34,17 +35,6 @@
# method: %(method)s
"""

MISSING_NETADDR = "Missing netaddr library. This is required for URL preview API."

MISSING_LXML = """Missing lxml library. This is required for URL preview API.
Install by running:
pip install lxml
Requires libxslt1-dev system package.
"""


ThumbnailRequirement = namedtuple(
"ThumbnailRequirement", ["width", "height", "method", "media_type"]
)
Expand Down Expand Up @@ -177,16 +167,10 @@ def read_config(self, config, **kwargs):
self.url_preview_enabled = config.get("url_preview_enabled", False)
if self.url_preview_enabled:
try:
import lxml

lxml # To stop unused lint.
except ImportError:
raise ConfigError(MISSING_LXML)
check_requirements("url_preview")

try:
from netaddr import IPSet
except ImportError:
raise ConfigError(MISSING_NETADDR)
except DependencyException as e:
raise ConfigError(e.message)

if "url_preview_ip_range_blacklist" not in config:
raise ConfigError(
Expand All @@ -195,6 +179,9 @@ def read_config(self, config, **kwargs):
"to work"
)

# netaddr is a dependency for url_preview
from netaddr import IPSet

self.url_preview_ip_range_blacklist = IPSet(
config["url_preview_ip_range_blacklist"]
)
Expand Down
8 changes: 7 additions & 1 deletion synapse/python_dependencies.py
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,13 @@ def check_requirements(for_feature=None):
)
except DistributionNotFound:
deps_needed.append(dependency)
errors.append("Needed %s but it was not installed" % (dependency,))
if for_feature:
errors.append(
"Needed %s for the '%s' feature but it was not installed"
% (dependency, for_feature)
)
else:
errors.append("Needed %s but it was not installed" % (dependency,))

if not for_feature:
# Check the optional dependencies are up to date. We allow them to not be
Expand Down

0 comments on commit c5d6fcc

Please sign in to comment.