Format

socials_util/__init__.py

@@ -1,6 +1,6 @@
-'''
+"""
 Small utility for detecting social websites.
-'''
+"""
 
 from dataclasses import dataclass
 from enforce_typing import enforce_types
@@ -12,10 +12,11 @@ import urllib.parse
 
 from socials_util._version import __version__
 
+
 class SocialSiteId(aenum.Enum):
-    '''
+    """
     The great social website enum.
-    '''
+    """
 
     # Reddit-like
     REDDIT = 1  # Should have been named REDDIT_SUBREDDIT
@@ -89,6 +90,7 @@ class SocialSiteId(aenum.Enum):
     def is_aggregator(self):
         return self in AGGERAGOR_SOCIALS
 
+
 AGGERAGOR_SOCIALS = {
     SocialSiteId.LINKTREE_PAGE,
     SocialSiteId.WIKIDATA,
@@ -98,6 +100,7 @@ AGGERAGOR_SOCIALS = {
     SocialSiteId.IGDB_GAME_ID,
 }
 
+
 @enforce_types
 @dataclass(frozen=True)
 class SocialLink(object):
@@ -105,6 +108,7 @@ class SocialLink(object):
     social_site_id: SocialSiteId
     social_id: Optional[str]
 
+
 @enforce_types
 @dataclass(frozen=True)
 class WikidataInfo(object):
@@ -113,10 +117,10 @@ class WikidataInfo(object):
     id_version_of: Optional[SocialSiteId] = None
     nickname_version_of: Optional[SocialSiteId] = None
 
+
 WIKIDATA_PROPERTIES = {
     SocialSiteId.EMAIL: WikidataInfo(968, None),
     SocialSiteId.RSS_FEED: WikidataInfo(1079, None),
-
     SocialSiteId.FACEBOOK_PAGE: WikidataInfo(2013, None),
     SocialSiteId.INSTAGRAM_PAGE: WikidataInfo(2003, None),
     SocialSiteId.LINKTREE_PAGE: WikidataInfo(11079, None),
@@ -127,21 +131,25 @@ WIKIDATA_PROPERTIES = {
     SocialSiteId.TWITCH: WikidataInfo(5797, None),
     SocialSiteId.TWITTER: WikidataInfo(2002, None),
     SocialSiteId.WIKIDATA: WikidataInfo(None, 2013),
-
     SocialSiteId.TUMBLR: WikidataInfo(3943, None),
     SocialSiteId.TIKTOK_USER: WikidataInfo(7085, None),
-
+    SocialSiteId.PIXIV_USER_ID: WikidataInfo(
-    SocialSiteId.PIXIV_USER_ID: WikidataInfo(5435, 306956, id_version_of = SocialSiteId.PIXIV_USER_NICKNAME),
+        5435, 306956, id_version_of=SocialSiteId.PIXIV_USER_NICKNAME
-    SocialSiteId.PIXIV_USER_NICKNAME: WikidataInfo(None, 306956, nickname_version_of = SocialSiteId.PIXIV_USER_ID),
+    ),
-
+    SocialSiteId.PIXIV_USER_NICKNAME: WikidataInfo(
+        None, 306956, nickname_version_of=SocialSiteId.PIXIV_USER_ID
+    ),
     SocialSiteId.MASTODON_PAGE: WikidataInfo(4033, None),
     SocialSiteId.PATREON_PAGE: WikidataInfo(4175, 15861362),
     SocialSiteId.ARTSTATION_PAGE: WikidataInfo(None, 65551500),
     # SocialSiteId.INPRNT_PAGE: WikidataInfo(None, None),
-
     SocialSiteId.CARRD_PAGE: WikidataInfo(None, 106036503),
-    SocialSiteId.YOUTUBE_CHANNEL_HANDLE: WikidataInfo(11245, 866, nickname_version_of = SocialSiteId.YOUTUBE_CHANNEL_ID),
+    SocialSiteId.YOUTUBE_CHANNEL_HANDLE: WikidataInfo(
-    SocialSiteId.YOUTUBE_CHANNEL_ID: WikidataInfo(2397, 866, id_version_of = SocialSiteId.YOUTUBE_CHANNEL_HANDLE),
+        11245, 866, nickname_version_of=SocialSiteId.YOUTUBE_CHANNEL_ID
+    ),
+    SocialSiteId.YOUTUBE_CHANNEL_ID: WikidataInfo(
+        2397, 866, id_version_of=SocialSiteId.YOUTUBE_CHANNEL_HANDLE
+    ),
     SocialSiteId.VIMEO_CHANNEL: WikidataInfo(4015, 156376),
     SocialSiteId.NEWGROUNDS_PAGE: WikidataInfo(None, 263655),
     SocialSiteId.ARTSY_ARTIST: WikidataInfo(2042, 4796642),
@@ -161,14 +169,12 @@ WIKIDATA_PROPERTIES = {
     SocialSiteId.LINKEDIN_PERSONAL_PROFILE: WikidataInfo(6634, None),
     SocialSiteId.MEDIUM_BLOG: WikidataInfo(3899, None),
     SocialSiteId.SUBSTACK: WikidataInfo(12007, None),
-
     SocialSiteId.INPRNT_PAGE: WikidataInfo(None, None),
     SocialSiteId.ETSY_SHOP: WikidataInfo(None, 1353939),
     SocialSiteId.KO_FI: WikidataInfo(None, 77949925),
     SocialSiteId.BEHANCE_PAGE: WikidataInfo(None, 4880667),
     SocialSiteId.PLURK: WikidataInfo(None, 32111),
     SocialSiteId.GOOGLE_BLOGGER_PAGE: WikidataInfo(None, 171186),
-
     # Weird internal
     SocialSiteId.LINK_COLLECTION_PAGE: WikidataInfo(None, None),
     SocialSiteId.PAGE_WATCH: WikidataInfo(None, None),
@@ -177,18 +183,22 @@ WIKIDATA_PROPERTIES = {
     SocialSiteId.FALKON_PROFILE_BOOKMARKS: WikidataInfo(None, None),
 }
 
+
 def re_social_subdomain(main_domain):
     # return r'^(?:https?:\/\/)?([\w_-]+)\.'+re.escape(main_domain)+'\/?$'
     return r'^(?:https?:\/\/)?([\w_-]+)\.' + re.escape(main_domain) + r'(\/.*)?$'
 
+
 RE_ID = r'@?([^/]+)'
 RE_DUAL_ID = r'@?([^/]+/[^/]+)'
 RE_ANY_SUBPATH = r'(|\/|\/.*)$'
 
+
 def re_social_path(main_domain):
     # return r'^(?:https?:\/\/)?(?:www\.)?'+re.escape(main_domain)+'\/'+RE_ID+'\/?$'
     return re_social_path_adv(main_domain, RE_ID)
 
+
 def re_social_path_adv(main_domain, *path):
     assert not main_domain.startswith('www.'), 'Redundant www.'
     l = [r'^', r'(?:https?:\/\/)?', r'(?:www\.)?', re.escape(main_domain)]
@@ -202,16 +212,21 @@ def re_social_path_adv(main_domain, *path):
     regex = ''.join(l)
     return regex
 
+
 MAILTO_URL = r'^mailto:(?:[\w._.]+@[\w._.]+)$'
 
 REDDIT_SUBREDDIT_URL = r'^(?:https?:\/\/)?(?:old\.)?reddit\.com\/r\/([\w-]+)\/?$'
-REDDIT_USER_URL = r'^(?:https?:\/\/)?(?:old\.)?reddit\.com\/user\/([\w-]+)(?:|\/submitted)\/?$'
+REDDIT_USER_URL = (
+    r'^(?:https?:\/\/)?(?:old\.)?reddit\.com\/user\/([\w-]+)(?:|\/submitted)\/?$'
+)
 TWITTER_HANDLE_URL_1 = re_social_path('twitter.com')
 TWITTER_HANDLE_URL_2 = re_social_path('x.com')
 LINKTREE_PAGE_URL = re_social_path('linktr.ee')
 TWITCH_STREAM_URL = re_social_path('twitch.tv')
 WIKIDATA_ITEM_URL = re_social_path_adv('wikidata.org', 'wiki', RE_ID)
-SONGKICK_ARTIST_URL = r'^(?:https?:\/\/)?(?:www\.)?songkick\.com\/artists\/(\d+)([\w-]*)\/?$'
+SONGKICK_ARTIST_URL = (
+    r'^(?:https?:\/\/)?(?:www\.)?songkick\.com\/artists\/(\d+)([\w-]*)\/?$'
+)
 TUMBLR_PAGE_URL = re_social_path('tumblr.com')
 TUMBLR_PAGE_URL_2 = re_social_subdomain('tumblr.com')
 INSTAGRAM_URL = re_social_path('instagram.com')
@@ -224,7 +239,9 @@ ETSY_SHOP_URL = re_social_path_adv('etsy.com', 'shop', RE_ID)
 BEHANCE_PAGE_URL = re_social_path('behance.net')
 TIKTOK_USER_URL = re_social_path('tiktok.com')
 PIXIV_USER_ID_URL = r'^(?:https?:\/\/)?(?:www\.)?pixiv\.net(?:\/en)?\/users/(\d+)\/?$'
-PIXIV_USER_ID_URL_2 = r'^(?:https?:\/\/)?(?:www\.)?pixiv\.net(?:\/en)?\/member\.php\/?[?]id=(\d+)$'
+PIXIV_USER_ID_URL_2 = (
+    r'^(?:https?:\/\/)?(?:www\.)?pixiv\.net(?:\/en)?\/member\.php\/?[?]id=(\d+)$'
+)
 PIXIV_FANBOX_USER_NICKNAME_URL = re_social_subdomain('fanbox.cc')
 PIXIV_USER_NICKNAME_URL = re_social_path_adv('pixiv.net', 'stacc', RE_ID)
 PIXIV_SKETCH_USER_NICKNAME_URL = re_social_path_adv('sketch.pixiv.net', RE_ID)
@@ -235,8 +252,12 @@ URL_PARSE_YOUTUBE_CHANNEL_HANDLE_2= re_social_path_adv('youtube.com', 'c', RE_ID
 URL_PARSE_YOUTUBE_CHANNEL_ID = re_social_path_adv('youtube.com', 'channel', RE_ID)
 URL_PARSE_VIMEO_CHANNEL = re_social_path_adv('vimeo.com', RE_ID)
 URL_PARSE_NEWGROUNDS_PAGE = re_social_subdomain('newgrounds.com')
-URL_PARSE_ARTSY_ARTIST = re_social_path_adv('artsy.net', 'artist', RE_ID, RE_ANY_SUBPATH)
+URL_PARSE_ARTSY_ARTIST = re_social_path_adv(
-URL_PARSE_ARTNET_ARTIST = re_social_path_adv('artnet.com', 'artists', RE_ID, RE_ANY_SUBPATH)
+    'artsy.net', 'artist', RE_ID, RE_ANY_SUBPATH
+)
+URL_PARSE_ARTNET_ARTIST = re_social_path_adv(
+    'artnet.com', 'artists', RE_ID, RE_ANY_SUBPATH
+)
 URL_PARSE_DEVIANT_ART_ACCOUNT = re_social_path_adv('deviantart.com', RE_ID)
 URL_PARSE_DEVIANT_ART_ACCOUNT_2 = re_social_subdomain('deviantart.com')
 URL_PARSE_DANBOORU_ARTIST = re_social_path_adv('danbooru.donmai.us', 'artists', RE_ID)
@@ -247,135 +268,104 @@ REGEXES = [
     # Reddit
     (REDDIT_SUBREDDIT_URL, SocialSiteId.REDDIT_SUBREDDIT),
     (REDDIT_USER_URL, SocialSiteId.REDDIT_USER),
-
     # Twitter
     (TWITTER_HANDLE_URL_1, SocialSiteId.TWITTER),
     (TWITTER_HANDLE_URL_2, SocialSiteId.TWITTER),
-
     # Facebook
     (FACEBOOK_PAGE_URL, SocialSiteId.FACEBOOK_PAGE),
-
     # Linktr.ee
     (LINKTREE_PAGE_URL, SocialSiteId.LINKTREE_PAGE),
-
     # Twitch.tv
     (TWITCH_STREAM_URL, SocialSiteId.TWITCH),
-
     # Wikidata
     (WIKIDATA_ITEM_URL, SocialSiteId.WIKIDATA),
-
     # Songkick
     (SONGKICK_ARTIST_URL, SocialSiteId.SONGKICK_ARTIST),
-
     # Tumblr
     (TUMBLR_PAGE_URL, SocialSiteId.TUMBLR),
     (TUMBLR_PAGE_URL_2, SocialSiteId.TUMBLR),
-
     # Instagram
     (INSTAGRAM_URL, SocialSiteId.INSTAGRAM_PAGE),
-
     # Tiktok
     (TIKTOK_USER_URL, SocialSiteId.TIKTOK_USER),
-
     # Pixiv
     (PIXIV_USER_ID_URL, SocialSiteId.PIXIV_USER_ID),
     (PIXIV_USER_ID_URL_2, SocialSiteId.PIXIV_USER_ID),
     (PIXIV_FANBOX_USER_NICKNAME_URL, SocialSiteId.PIXIV_USER_NICKNAME),
     (PIXIV_USER_NICKNAME_URL, SocialSiteId.PIXIV_USER_NICKNAME),
     (PIXIV_SKETCH_USER_NICKNAME_URL, SocialSiteId.PIXIV_USER_NICKNAME),
-
     # Patreon
     (PATREON_URL, SocialSiteId.PATREON_PAGE),
-
     # Artstation
     (ARTSTATION_URL, SocialSiteId.ARTSTATION_PAGE),
-
     # Inprnt
     (INPRNT_URL, SocialSiteId.INPRNT_PAGE),
-
     # Email
     (MAILTO_URL, SocialSiteId.EMAIL),
-
     # Substack
     (SUBSTACK_PREFIX_URL, SocialSiteId.SUBSTACK),
-
     # Medium
     (re_social_path_adv('medium.com', RE_ID), SocialSiteId.MEDIUM_BLOG),
     (re_social_subdomain('medium.com'), SocialSiteId.MEDIUM_BLOG),
-
     # Etsy shop
     (ETSY_SHOP_URL, SocialSiteId.ETSY_SHOP),
-
     # Ko-fi
     (re_social_path_adv('ko-fi.com', RE_ID), SocialSiteId.KO_FI),
     (re_social_path_adv('ko-fi.com', RE_ID, 'shop'), SocialSiteId.KO_FI),
-
     # Behance
     (BEHANCE_PAGE_URL, SocialSiteId.BEHANCE_PAGE),
-
     # Carrd
     (URL_PARSE_CARRD_PAGE, SocialSiteId.CARRD_PAGE),
-
     # Youtube
     (URL_PARSE_YOUTUBE_CHANNEL_HANDLE_1, SocialSiteId.YOUTUBE_CHANNEL_HANDLE),
     (URL_PARSE_YOUTUBE_CHANNEL_HANDLE_2, SocialSiteId.YOUTUBE_CHANNEL_HANDLE),
     (URL_PARSE_YOUTUBE_CHANNEL_ID, SocialSiteId.YOUTUBE_CHANNEL_ID),
-
     # Vimeo
     (URL_PARSE_VIMEO_CHANNEL, SocialSiteId.VIMEO_CHANNEL),
-
     # Newgrounds
     (URL_PARSE_NEWGROUNDS_PAGE, SocialSiteId.NEWGROUNDS_PAGE),
-
     # Artsy
     (URL_PARSE_ARTSY_ARTIST, SocialSiteId.ARTSY_ARTIST),
     (URL_PARSE_ARTNET_ARTIST, SocialSiteId.ARTNET_ARTIST),
-
     # Deviant art
     (URL_PARSE_DEVIANT_ART_ACCOUNT, SocialSiteId.DEVIANT_ART_ACCOUNT),
     (URL_PARSE_DEVIANT_ART_ACCOUNT_2, SocialSiteId.DEVIANT_ART_ACCOUNT),
-
     # Danbooru
     (URL_PARSE_DANBOORU_ARTIST, SocialSiteId.DANBOORU_ARTIST),
-
     # Bandcamp
     (URL_PARSE_BANDCAMP, SocialSiteId.BANDCAMP_PROFILE),
-
     # Bluesky
     (URL_PARSE_BLUESKY, SocialSiteId.BLUESKY_PROFILE),
-
     # Threads
     (re_social_path_adv('threads.net', RE_ID), SocialSiteId.THREADS_USERNAME),
-
     # Itch.io
     (re_social_subdomain('itch.io'), SocialSiteId.ITCH_IO_DEVELOPER),
-
     # Cohost
     (re_social_path_adv('cohost.org', RE_ID), SocialSiteId.COHOST_PROFILE),
-
     # Soundcloud
     (re_social_path_adv('soundcloud.com', RE_ID), SocialSiteId.SOUNDCLOUD_ARTIST),
-
     # IGDB
     (re_social_path_adv('igdb.com', 'games', RE_ID), SocialSiteId.IGDB_GAME_ID),
-
     # Steam game
-    (re_social_path_adv('store.steampowered.com', 'app', RE_ID, RE_ANY_SUBPATH), SocialSiteId.STEAM_APPLICATION_ID),
+    (
-
+        re_social_path_adv('store.steampowered.com', 'app', RE_ID, RE_ANY_SUBPATH),
+        SocialSiteId.STEAM_APPLICATION_ID,
+    ),
     # Github
     (re_social_path_adv('github.com', RE_DUAL_ID), SocialSiteId.GITHUB_REPOSITORY),
-
     # Plurk
     (re_social_path_adv('plurk.com', RE_ID), SocialSiteId.PLURK),
-
     # Linked in
-    (re_social_path_adv('linkedin.com', 'in', RE_ID), SocialSiteId.LINKEDIN_PERSONAL_PROFILE),
+    (
-
+        re_social_path_adv('linkedin.com', 'in', RE_ID),
+        SocialSiteId.LINKEDIN_PERSONAL_PROFILE,
+    ),
     # Google Blogger
     (re_social_subdomain('blogspot.com'), SocialSiteId.GOOGLE_BLOGGER_PAGE),
 ]
 
-WELL_KNOWN_MASTODON_INSTANCES = frozenset({
+WELL_KNOWN_MASTODON_INSTANCES = frozenset(
+    {
         # Includes all servers with 50 000+ users as of 6 july 2023.
         # based on https://mastodonservers.net/servers/top
         'mastodon.social',
@@ -394,13 +384,15 @@ WELL_KNOWN_MASTODON_INSTANCES = frozenset({
         'mastodonapp.uk',
         'fosstodon.org',
         'idlethumbs.social',
-})
+    }
+)
+
 
 def determine_social_from_url_internally(url: str):
     assert isinstance(url, str)
 
     # Regexes
-    for (social_site_url_regex, social_site_id) in REGEXES:
+    for social_site_url_regex, social_site_id in REGEXES:
         if m := re.fullmatch(social_site_url_regex, url, re.I):
             groups = m.groups()
             return (social_site_id, groups[0] if len(groups) > 0 else None)
@@ -418,14 +410,18 @@ def determine_social_from_url_internally(url: str):
 
     return (None, None)
 
+
 def determine_social_from_url(url):
     if isinstance(url, str):
         url = urllib.parse.urlparse(url)
-    (social_site_id, social_id) = determine_social_from_url_internally(url._replace(query = '', fragment = '').geturl())
+    (social_site_id, social_id) = determine_social_from_url_internally(
+        url._replace(query='', fragment='').geturl()
+    )
     if not social_site_id:
-        (social_site_id, social_id) = determine_social_from_url_internally(url._replace(fragment = '').geturl())
+        (social_site_id, social_id) = determine_social_from_url_internally(
+            url._replace(fragment='').geturl()
+        )
 
     if not social_site_id:
         return None
     return SocialLink(url, social_site_id, social_id)
-

socials_util/_version.py

@@ -1 +1 @@
-__version__ = "0.1.1"
+__version__ = '0.1.1'

test/test_consistency.py

@@ -1,9 +1,7 @@
-
 import socials_util
 import pytest
 
+
 @pytest.mark.parametrize('social_site_id', list(socials_util.SocialSiteId))
 def test_consistency(social_site_id):
     assert social_site_id in socials_util.WIKIDATA_PROPERTIES
-
-

test/test_extension.py

@@ -1,7 +1,7 @@
-
 from socials_util import *
 import aenum
 
+
 def test_extension():
     MY_SECRET_SITE = aenum.extend_enum(SocialSiteId, 'MY_SECRET_SITE', 666)
     assert MY_SECRET_SITE
@@ -14,4 +14,3 @@ def test_extension():
     assert result is not None
     assert result.social_site_id == MY_SECRET_SITE
     assert result.social_id == '123'
-

test/test_parsing.py

@@ -1,20 +1,58 @@
-
 from socials_util import *
 
+
 def test_parsing():
     assert determine_social_from_url('http://www.twitter.com/dril').social_id == 'dril'
     assert determine_social_from_url('http://worstdril.tumblr.com/')
-    assert determine_social_from_url('https://deep-dark-fears.tumblr.com').social_id == 'deep-dark-fears'
+    assert (
-    assert determine_social_from_url('https://www.etsy.com/shop/aleksiremesart').social_id == 'aleksiremesart'
+        determine_social_from_url('https://deep-dark-fears.tumblr.com').social_id
-    assert determine_social_from_url('https://ko-fi.com/A627LI1/shop').social_id == 'A627LI1'
+        == 'deep-dark-fears'
-    assert determine_social_from_url('https://ko-fi.com/A627LI1/').social_id == 'A627LI1'
+    )
-    assert determine_social_from_url('https://www.facebook.com/fredagscafeen.dk/').social_id == 'fredagscafeen.dk'
+    assert (
-    assert determine_social_from_url('https://www.tiktok.com/@depthsofwikipedia?lang=en').social_id == 'depthsofwikipedia'
+        determine_social_from_url('https://www.etsy.com/shop/aleksiremesart').social_id
-    assert determine_social_from_url('https://www.pixiv.net/users/14866303').social_id == '14866303'
+        == 'aleksiremesart'
-    assert determine_social_from_url('https://www.pixiv.net/member.php?id=109710').social_id == '109710'
+    )
-    assert determine_social_from_url('https://www.deviantart.com/solquiet').social_site_id == SocialSiteId.DEVIANT_ART_ACCOUNT
+    assert (
-    assert determine_social_from_url('https://solquiet.deviantart.com/').social_site_id == SocialSiteId.DEVIANT_ART_ACCOUNT
+        determine_social_from_url('https://ko-fi.com/A627LI1/shop').social_id
-    assert determine_social_from_url('https://cohost.org/example').social_site_id == SocialSiteId.COHOST_PROFILE
+        == 'A627LI1'
+    )
+    assert (
+        determine_social_from_url('https://ko-fi.com/A627LI1/').social_id == 'A627LI1'
+    )
+    assert (
+        determine_social_from_url(
+            'https://www.facebook.com/fredagscafeen.dk/'
+        ).social_id
+        == 'fredagscafeen.dk'
+    )
+    assert (
+        determine_social_from_url(
+            'https://www.tiktok.com/@depthsofwikipedia?lang=en'
+        ).social_id
+        == 'depthsofwikipedia'
+    )
+    assert (
+        determine_social_from_url('https://www.pixiv.net/users/14866303').social_id
+        == '14866303'
+    )
+    assert (
+        determine_social_from_url(
+            'https://www.pixiv.net/member.php?id=109710'
+        ).social_id
+        == '109710'
+    )
+    assert (
+        determine_social_from_url('https://www.deviantart.com/solquiet').social_site_id
+        == SocialSiteId.DEVIANT_ART_ACCOUNT
+    )
+    assert (
+        determine_social_from_url('https://solquiet.deviantart.com/').social_site_id
+        == SocialSiteId.DEVIANT_ART_ACCOUNT
+    )
+    assert (
+        determine_social_from_url('https://cohost.org/example').social_site_id
+        == SocialSiteId.COHOST_PROFILE
+    )
 
     INSTAGRAMS = [
         'https://instagram.com/_richardparry_',
@@ -26,5 +64,6 @@ def test_parsing():
     ]
 
     for ig in INSTAGRAMS:
-        assert determine_social_from_url(ig).social_site_id == SocialSiteId.INSTAGRAM_PAGE
+        assert (
-
+            determine_social_from_url(ig).social_site_id == SocialSiteId.INSTAGRAM_PAGE
+        )