@suss/adapter-python 0.32.0 → 0.33.1

package/dist/index.d.cts

@@ -115,6 +115,8 @@ interface PythonPack {
     contextManagers?: PyContextManager[];
     /** How the library lets a project hand the database SQL it wrote itself. */
     rawSql?: RawSqlPattern[];
+    /** The client objects the library hands a project, and the calls on one that reach the database. */
+    sqlClients?: SqlClientPattern[];
 }
 /**
  * A call talks to the database when the method behind it says it returns one
@@ -212,6 +214,66 @@ interface RawSqlPattern {
     /** Which database the library is talking to, for the boundary binding. */
     storageSystem: "postgresql" | "mysql" | "sqlite";
 }
+/**
+ * A client object a library hands a project, and the calls on one that
+ * reach the database. `RawSqlPattern` matches a function the file
+ * imported; this matches a method on a value whose class came out of
+ * the library, which is how a client built in one module and called in
+ * another still reads.
+ *
+ * Every field here is the library's own: the module, the class names,
+ * the method names, and where each method takes what it is given.
+ */
+interface SqlClientPattern {
+    /** The module the client class comes from, `google.cloud.bigquery`. */
+    module: string;
+    /** The class names whose instances take these calls, `Client`. */
+    clientTypes: string[];
+    /** The methods that hand the database a statement, and where each takes it. */
+    statements?: SqlStatementCall[];
+    /** The methods that say which table rather than writing SQL, and what each does to it. */
+    tables?: SqlTableCall[];
+    /** The methods that hand back one of another library class, so a chain off one reaches its calls. */
+    handsBack?: SqlClientHandoff[];
+    /** Which database the client is talking to, for the boundary binding. */
+    storageSystem: string;
+    /** Which SQL dialect the statements are written in, when that is not the storage system's own name. */
+    dialect?: string;
+}
+/** Where one method takes what it is given: a position, a keyword, or both. */
+interface SqlCallArgument {
+    /** The position it is written at. */
+    argument?: number;
+    /** The keyword it may be written under instead. */
+    keyword?: string;
+}
+/** One method that takes a statement written as SQL. */
+interface SqlStatementCall extends SqlCallArgument {
+    /** The method name, `query`. */
+    method: string;
+    /**
+     * The keys down to the statement when it travels inside a dictionary
+     * rather than as the argument itself, the `["query", "query"]` of
+     * `insert_job(configuration={"query": {"query": sql}})`.
+     */
+    path?: string[];
+}
+/** One method that says which table it works on, and what it does to it. */
+interface SqlTableCall extends SqlCallArgument {
+    /** The method name, `get_table`. */
+    method: string;
+    /** Whether the call changes what is stored. */
+    kind: "read" | "write";
+}
+/** One method that hands back an object of another of the library's classes. */
+interface SqlClientHandoff {
+    /** The method name, Airflow's `get_client`. */
+    method: string;
+    /** The module the class it hands back comes from. */
+    module: string;
+    /** That class's name. */
+    name: string;
+}
 type PythonDiscoveryPattern = DecoratedClassRoute | DecoratedFunctionRoute;
 /**
  * A class whose `__enter__` gives back the object it was called on, so
@@ -768,6 +830,8 @@ interface StorageLookup {
     readonly couldMatch: ReadonlySet<string>;
     /** What a pack says about statements a project writes as SQL itself. */
     readonly rawSql?: readonly RawSqlPattern[];
+    /** What a pack says about the client objects its library hands a project. */
+    readonly sqlClients?: readonly SqlClientPattern[];
 }
 
 /**
@@ -1112,4 +1176,4 @@ declare function pythonImportEvidence(options: PythonImportEvidenceOptions): Pro
  */
 declare const ADAPTER_VERSION = "0.1.0";
 
-export { ADAPTER_VERSION, type AnnotationContext, type Binding, type BoundPythonFile, type DecoratedClassRoute, type DecoratedFunctionRoute, type DecoratorArg, type DecoratorClassification, type DiscoveryOptions, type ExtractPythonOptions, type ExtractPythonResult, type FileFactsOptions, type ModuleBinding, type ModuleResolution, type ModuleResolverOptions, type MountObjectCarrier, type MountObjectPrefix, type MountPrefixEffect, type NoValuePrefix, type PathRepeatedSlashes, type PrefixTrailingSlash, type PyModelEntryFunction, type PyModelEntryMethod, type PyModelQueries, type PyStatusCall, type PythonDiscoveryPattern, type PythonImportEvidence, type PythonImportEvidenceOptions, type PythonImportSite, type PythonPack, type PythonValueHandle, PythonWhySession, type PythonWhySessionOptions, type RawSqlPattern, type RelativeModuleSpec, type RouteConventions, type RoutePrefixResolution, type RouterComposition, type RouterIndex, type Scope, type ScopeKind, type StoragePattern, annotationToShape, bindModule, buildRouterIndex, classifyDecorator, containedValues, discoverUnits, emitEntryFact, emitModuleImportFacts, emitValueFacts, extractPythonProject, factsForFile, findPythonFiles, nameKeyIn, nodeId, objectReturnedBy, parsePython, parsePythonSync, preloadPythonGrammar, pythonImportEvidence, readKey, resolveAbsoluteModule, resolveCalls, resolveModule, resolveName, resolveRelativeModule, shapeFromName, unitKey };
+export { ADAPTER_VERSION, type AnnotationContext, type Binding, type BoundPythonFile, type DecoratedClassRoute, type DecoratedFunctionRoute, type DecoratorArg, type DecoratorClassification, type DiscoveryOptions, type ExtractPythonOptions, type ExtractPythonResult, type FileFactsOptions, type ModuleBinding, type ModuleResolution, type ModuleResolverOptions, type MountObjectCarrier, type MountObjectPrefix, type MountPrefixEffect, type NoValuePrefix, type PathRepeatedSlashes, type PrefixTrailingSlash, type PyModelEntryFunction, type PyModelEntryMethod, type PyModelQueries, type PyStatusCall, type PythonDiscoveryPattern, type PythonImportEvidence, type PythonImportEvidenceOptions, type PythonImportSite, type PythonPack, type PythonValueHandle, PythonWhySession, type PythonWhySessionOptions, type RawSqlPattern, type RelativeModuleSpec, type RouteConventions, type RoutePrefixResolution, type RouterComposition, type RouterIndex, type Scope, type ScopeKind, type SqlCallArgument, type SqlClientHandoff, type SqlClientPattern, type SqlStatementCall, type SqlTableCall, type StoragePattern, annotationToShape, bindModule, buildRouterIndex, classifyDecorator, containedValues, discoverUnits, emitEntryFact, emitModuleImportFacts, emitValueFacts, extractPythonProject, factsForFile, findPythonFiles, nameKeyIn, nodeId, objectReturnedBy, parsePython, parsePythonSync, preloadPythonGrammar, pythonImportEvidence, readKey, resolveAbsoluteModule, resolveCalls, resolveModule, resolveName, resolveRelativeModule, shapeFromName, unitKey };

package/dist/index.d.ts

@@ -115,6 +115,8 @@ interface PythonPack {
     contextManagers?: PyContextManager[];
     /** How the library lets a project hand the database SQL it wrote itself. */
     rawSql?: RawSqlPattern[];
+    /** The client objects the library hands a project, and the calls on one that reach the database. */
+    sqlClients?: SqlClientPattern[];
 }
 /**
  * A call talks to the database when the method behind it says it returns one
@@ -212,6 +214,66 @@ interface RawSqlPattern {
     /** Which database the library is talking to, for the boundary binding. */
     storageSystem: "postgresql" | "mysql" | "sqlite";
 }
+/**
+ * A client object a library hands a project, and the calls on one that
+ * reach the database. `RawSqlPattern` matches a function the file
+ * imported; this matches a method on a value whose class came out of
+ * the library, which is how a client built in one module and called in
+ * another still reads.
+ *
+ * Every field here is the library's own: the module, the class names,
+ * the method names, and where each method takes what it is given.
+ */
+interface SqlClientPattern {
+    /** The module the client class comes from, `google.cloud.bigquery`. */
+    module: string;
+    /** The class names whose instances take these calls, `Client`. */
+    clientTypes: string[];
+    /** The methods that hand the database a statement, and where each takes it. */
+    statements?: SqlStatementCall[];
+    /** The methods that say which table rather than writing SQL, and what each does to it. */
+    tables?: SqlTableCall[];
+    /** The methods that hand back one of another library class, so a chain off one reaches its calls. */
+    handsBack?: SqlClientHandoff[];
+    /** Which database the client is talking to, for the boundary binding. */
+    storageSystem: string;
+    /** Which SQL dialect the statements are written in, when that is not the storage system's own name. */
+    dialect?: string;
+}
+/** Where one method takes what it is given: a position, a keyword, or both. */
+interface SqlCallArgument {
+    /** The position it is written at. */
+    argument?: number;
+    /** The keyword it may be written under instead. */
+    keyword?: string;
+}
+/** One method that takes a statement written as SQL. */
+interface SqlStatementCall extends SqlCallArgument {
+    /** The method name, `query`. */
+    method: string;
+    /**
+     * The keys down to the statement when it travels inside a dictionary
+     * rather than as the argument itself, the `["query", "query"]` of
+     * `insert_job(configuration={"query": {"query": sql}})`.
+     */
+    path?: string[];
+}
+/** One method that says which table it works on, and what it does to it. */
+interface SqlTableCall extends SqlCallArgument {
+    /** The method name, `get_table`. */
+    method: string;
+    /** Whether the call changes what is stored. */
+    kind: "read" | "write";
+}
+/** One method that hands back an object of another of the library's classes. */
+interface SqlClientHandoff {
+    /** The method name, Airflow's `get_client`. */
+    method: string;
+    /** The module the class it hands back comes from. */
+    module: string;
+    /** That class's name. */
+    name: string;
+}
 type PythonDiscoveryPattern = DecoratedClassRoute | DecoratedFunctionRoute;
 /**
  * A class whose `__enter__` gives back the object it was called on, so
@@ -768,6 +830,8 @@ interface StorageLookup {
     readonly couldMatch: ReadonlySet<string>;
     /** What a pack says about statements a project writes as SQL itself. */
     readonly rawSql?: readonly RawSqlPattern[];
+    /** What a pack says about the client objects its library hands a project. */
+    readonly sqlClients?: readonly SqlClientPattern[];
 }
 
 /**
@@ -1112,4 +1176,4 @@ declare function pythonImportEvidence(options: PythonImportEvidenceOptions): Pro
  */
 declare const ADAPTER_VERSION = "0.1.0";
 
-export { ADAPTER_VERSION, type AnnotationContext, type Binding, type BoundPythonFile, type DecoratedClassRoute, type DecoratedFunctionRoute, type DecoratorArg, type DecoratorClassification, type DiscoveryOptions, type ExtractPythonOptions, type ExtractPythonResult, type FileFactsOptions, type ModuleBinding, type ModuleResolution, type ModuleResolverOptions, type MountObjectCarrier, type MountObjectPrefix, type MountPrefixEffect, type NoValuePrefix, type PathRepeatedSlashes, type PrefixTrailingSlash, type PyModelEntryFunction, type PyModelEntryMethod, type PyModelQueries, type PyStatusCall, type PythonDiscoveryPattern, type PythonImportEvidence, type PythonImportEvidenceOptions, type PythonImportSite, type PythonPack, type PythonValueHandle, PythonWhySession, type PythonWhySessionOptions, type RawSqlPattern, type RelativeModuleSpec, type RouteConventions, type RoutePrefixResolution, type RouterComposition, type RouterIndex, type Scope, type ScopeKind, type StoragePattern, annotationToShape, bindModule, buildRouterIndex, classifyDecorator, containedValues, discoverUnits, emitEntryFact, emitModuleImportFacts, emitValueFacts, extractPythonProject, factsForFile, findPythonFiles, nameKeyIn, nodeId, objectReturnedBy, parsePython, parsePythonSync, preloadPythonGrammar, pythonImportEvidence, readKey, resolveAbsoluteModule, resolveCalls, resolveModule, resolveName, resolveRelativeModule, shapeFromName, unitKey };
+export { ADAPTER_VERSION, type AnnotationContext, type Binding, type BoundPythonFile, type DecoratedClassRoute, type DecoratedFunctionRoute, type DecoratorArg, type DecoratorClassification, type DiscoveryOptions, type ExtractPythonOptions, type ExtractPythonResult, type FileFactsOptions, type ModuleBinding, type ModuleResolution, type ModuleResolverOptions, type MountObjectCarrier, type MountObjectPrefix, type MountPrefixEffect, type NoValuePrefix, type PathRepeatedSlashes, type PrefixTrailingSlash, type PyModelEntryFunction, type PyModelEntryMethod, type PyModelQueries, type PyStatusCall, type PythonDiscoveryPattern, type PythonImportEvidence, type PythonImportEvidenceOptions, type PythonImportSite, type PythonPack, type PythonValueHandle, PythonWhySession, type PythonWhySessionOptions, type RawSqlPattern, type RelativeModuleSpec, type RouteConventions, type RoutePrefixResolution, type RouterComposition, type RouterIndex, type Scope, type ScopeKind, type SqlCallArgument, type SqlClientHandoff, type SqlClientPattern, type SqlStatementCall, type SqlTableCall, type StoragePattern, annotationToShape, bindModule, buildRouterIndex, classifyDecorator, containedValues, discoverUnits, emitEntryFact, emitModuleImportFacts, emitValueFacts, extractPythonProject, factsForFile, findPythonFiles, nameKeyIn, nodeId, objectReturnedBy, parsePython, parsePythonSync, preloadPythonGrammar, pythonImportEvidence, readKey, resolveAbsoluteModule, resolveCalls, resolveModule, resolveName, resolveRelativeModule, shapeFromName, unitKey };