codebase: extend typeshi integration to graphql queries

Author: seven7ty

cli/main.py

@@ -1,9 +1,11 @@
 import os
 import sys
+import json
 import click
 import typeshi
 import subprocess
 from lib.structs.proxies.dict_proxy import DictProxy
+from lib.structs.proxies.dir_proxy import DirProxy
 from .config import PYTHON_COMMAND_LINE, APP_ROOT_DIR
 from .scripts import run_help_helper
 
@@ -43,6 +45,19 @@ def generate_locale_defs():
     )
     print(f'Wrote locale schema to resources/gen/locale_schema.py')
 
+@dev.command('generate-graphql-query-def')
+def generate_query_dirproxy_def():
+    if not os.path.exists('resources/gen/'):
+        os.makedirs('resources/gen/')
+    query_names: list[str] = list(map(lambda fn: fn[:-8], filter(lambda fn: fn.endswith('.graphql'), os.listdir('resources/queries/'))))
+    with open('tmp/gql.json', 'w+') as f:
+        json.dump({q: '_str' for q in query_names}, f)
+    typeshi.save_declaration_module_from_json(
+        'GraphQLQueries', 'tmp/gql.json', 'resources/gen/gql_queries_schema.py',
+        inherit_cls=DirProxy, literals_where_possible=False
+    )
+    os.remove('tmp/gql.json')
+    print(f'Wrote query directory schema to resources/gen/gql_queries_schema.py')
 
 @dev.command('update', help='Update the local code using git')
 def update():

lib/api/github/github.py

@@ -16,9 +16,9 @@
 from typing import Optional, Callable, Any, Literal, TYPE_CHECKING
 from gidgethub import BadRequest, QueryError
 import datetime
-from lib.structs import DirProxy, TypedCache, CacheSchema, DictProxy, SnakeCaseDictProxy
+from lib.structs import TypedCache, CacheSchema, DictProxy, SnakeCaseDictProxy
 from lib.utils.decorators import normalize_repository, validate_github_name
-from lib.typehints import GitHubRepository, GitHubOrganization, GitHubUser
+from lib.typehints import GitHubRepository, GitHubOrganization, GitHubUser, GraphQLQueriesDirProxyDef
 from lib.utils import get_nested_key, get_all_dict_paths, set_nested_key
 from cogs.backend.handle.errors._error_tools import log_error_in_discord
 from .transformations import *
@@ -204,7 +204,7 @@ class GitHubAPI:
     def __init__(self, bot: 'GitBot', token: str, session: aiohttp.ClientSession):
         self.bot: 'GitBot' = bot
         self.__token: str = token
-        self.queries: DirProxy = DirProxy('./resources/queries/', ('.gql', '.graphql'))
+        self.queries: GraphQLQueriesDirProxyDef = GraphQLQueriesDirProxyDef('./resources/queries/', ('.gql', '.graphql'))
         self.session: aiohttp.ClientSession = session
         self.gh: gh.GitHubAPI = gh.GitHubAPI(session=self.session, requester=self.requester, oauth_token=self.__token)
 

lib/typehints/__init__.py

@@ -6,7 +6,7 @@
 from lib.typehints.db.guild.autoconv import AutomaticConversionSettings
 from lib.typehints.generic import *
 from lib.typehints.locale.help import *
-from lib.typehints.locale.localedef_wfallback import LocaleDictProxyDef
+from lib.typehints.resource_defs_wfallbacks import *
 from lib.typehints.db.guild.release_feed import *
 from lib.typehints.gitbot_config import *
 
@@ -37,7 +37,8 @@
     'CratesIOCrate',
     'ReleaseFeedItemMention',
     'GitbotRepoConfig',
-    'LocaleDictProxyDef'
+    'LocaleDictProxyDef',
+    'GraphQLQueriesDirProxyDef'
 )
 
 AnyDict = dict | DictProxy | CaseInsensitiveDict | MaxAgeDict | FixedSizeOrderedDict

lib/typehints/locale/localedef_wfallback.py

@@ -1,16 +1,17 @@
 # coding: utf-8
 
 from lib.structs.proxies.dict_proxy import DictProxy
+from lib.structs.proxies.dir_proxy import DirProxy
 
 try:
     from resources.gen.locale_schema import Locale as LocaleDictProxyDef
 except ImportError:
     LocaleDictProxyDef = DictProxy
 
 try:
-    from resources.gen.env_defaults_schema import EnvDefaults as EnvDefaultsProxyDef
+    from resources.gen.gql_queries_schema import GraphQLQueries as GraphQLQueriesDirProxyDef
 except ImportError:
-    EnvDefaultsProxyDef = DictProxy
+    GraphQLQueriesDirProxyDef = DirProxy
 
 
-__all__: tuple = ('LocaleDictProxyDef', 'EnvDefaultsProxyDef')
+__all__: tuple = ('LocaleDictProxyDef', 'GraphQLQueriesDirProxyDef')