python-sqlmodel/sqlmodel/sql/expression.py at main · bryanchance/python-sqlmodel · GitHub

Repository navigation

History

619 lines (475 loc) · 14.3 KB

Raw

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

# WARNING: do not modify this code, it is generated by expression.py.jinja2

from datetime import datetime

from typing import (

Any,

Iterable,

Mapping,

Optional,

Sequence,

Tuple,

Type,

TypeVar,

Union,

overload,

)

from uuid import UUID

import sqlalchemy

from sqlalchemy import (

Column,

ColumnElement,

Extract,

FunctionElement,

FunctionFilter,

Label,

Over,

TypeCoerce,

WithinGroup,

)

from sqlalchemy.orm import InstrumentedAttribute, Mapped

from sqlalchemy.sql._typing import (

_ColumnExpressionArgument,

_ColumnExpressionOrLiteralArgument,

_ColumnExpressionOrStrLabelArgument,

)

from sqlalchemy.sql.elements import (

BinaryExpression,

Case,

Cast,

CollectionAggregate,

ColumnClause,

SQLCoreOperations,

TryCast,

UnaryExpression,

)

from sqlalchemy.sql.expression import Select as _Select

from sqlalchemy.sql.roles import TypedColumnsClauseRole

from sqlalchemy.sql.type_api import TypeEngine

from typing_extensions import Literal, Self

_T = TypeVar("_T")

_TypeEngineArgument = Union[Type[TypeEngine[_T]], TypeEngine[_T]]

# Redefine operatos that would only take a column expresion to also take the (virtual)

# types of Pydantic models, e.g. str instead of only Mapped[str].

def all_(expr: Union[_ColumnExpressionArgument[_T], _T]) -> CollectionAggregate[bool]:

return sqlalchemy.all_(expr) # type: ignore[arg-type]

def and_(

initial_clause: Union[Literal[True], _ColumnExpressionArgument[bool], bool],

*clauses: Union[_ColumnExpressionArgument[bool], bool],

) -> ColumnElement[bool]:

return sqlalchemy.and_(initial_clause, *clauses) # type: ignore[arg-type]

def any_(expr: Union[_ColumnExpressionArgument[_T], _T]) -> CollectionAggregate[bool]:

return sqlalchemy.any_(expr) # type: ignore[arg-type]

def asc(

column: Union[_ColumnExpressionOrStrLabelArgument[_T], _T],

) -> UnaryExpression[_T]:

return sqlalchemy.asc(column) # type: ignore[arg-type]

def collate(

expression: Union[_ColumnExpressionArgument[str], str], collation: str

) -> BinaryExpression[str]:

return sqlalchemy.collate(expression, collation) # type: ignore[arg-type]

def between(

expr: Union[_ColumnExpressionOrLiteralArgument[_T], _T],

lower_bound: Any,

upper_bound: Any,

symmetric: bool = False,

) -> BinaryExpression[bool]:

return sqlalchemy.between(expr, lower_bound, upper_bound, symmetric=symmetric) # type: ignore[arg-type]

def not_(clause: Union[_ColumnExpressionArgument[_T], _T]) -> ColumnElement[_T]:

return sqlalchemy.not_(clause) # type: ignore[arg-type]

def case(

*whens: Union[

Tuple[Union[_ColumnExpressionArgument[bool], bool], Any], Mapping[Any, Any]

value: Optional[Any] = None,

else_: Optional[Any] = None,

) -> Case[Any]:

return sqlalchemy.case(*whens, value=value, else_=else_) # type: ignore[arg-type]

def cast(

expression: Union[_ColumnExpressionOrLiteralArgument[Any], Any],

type_: "_TypeEngineArgument[_T]",

) -> Cast[_T]:

return sqlalchemy.cast(expression, type_) # type: ignore[arg-type]

def try_cast(

expression: Union[_ColumnExpressionOrLiteralArgument[Any], Any],

type_: "_TypeEngineArgument[_T]",

) -> TryCast[_T]:

return sqlalchemy.try_cast(expression, type_) # type: ignore[arg-type]

def desc(

column: Union[_ColumnExpressionOrStrLabelArgument[_T], _T],

) -> UnaryExpression[_T]:

return sqlalchemy.desc(column) # type: ignore[arg-type]

def distinct(expr: Union[_ColumnExpressionArgument[_T], _T]) -> UnaryExpression[_T]:

return sqlalchemy.distinct(expr) # type: ignore[arg-type]

def bitwise_not(expr: Union[_ColumnExpressionArgument[_T], _T]) -> UnaryExpression[_T]:

return sqlalchemy.bitwise_not(expr) # type: ignore[arg-type]

def extract(field: str, expr: Union[_ColumnExpressionArgument[Any], Any]) -> Extract:

return sqlalchemy.extract(field, expr) # type: ignore[arg-type]

def funcfilter(

func: FunctionElement[_T], *criterion: Union[_ColumnExpressionArgument[bool], bool]

) -> FunctionFilter[_T]:

return sqlalchemy.funcfilter(func, *criterion) # type: ignore[arg-type]

def label(

name: str,

element: Union[_ColumnExpressionArgument[_T], _T],

type_: Optional["_TypeEngineArgument[_T]"] = None,

) -> Label[_T]:

return sqlalchemy.label(name, element, type_=type_) # type: ignore[arg-type]

def nulls_first(

column: Union[_ColumnExpressionArgument[_T], _T]

) -> UnaryExpression[_T]:

return sqlalchemy.nulls_first(column) # type: ignore[arg-type]

def nulls_last(column: Union[_ColumnExpressionArgument[_T], _T]) -> UnaryExpression[_T]:

return sqlalchemy.nulls_last(column) # type: ignore[arg-type]

def or_( # type: ignore[empty-body]

initial_clause: Union[Literal[False], _ColumnExpressionArgument[bool], bool],

*clauses: Union[_ColumnExpressionArgument[bool], bool],

) -> ColumnElement[bool]:

return sqlalchemy.or_(initial_clause, *clauses) # type: ignore[arg-type]

def over(

element: FunctionElement[_T],

partition_by: Optional[

Union[

Iterable[Union[_ColumnExpressionArgument[Any], Any]],

_ColumnExpressionArgument[Any],

Any,

]

] = None,

order_by: Optional[

Union[

Iterable[Union[_ColumnExpressionArgument[Any], Any]],

_ColumnExpressionArgument[Any],

Any,

]

] = None,

range_: Optional[Tuple[Optional[int], Optional[int]]] = None,

rows: Optional[Tuple[Optional[int], Optional[int]]] = None,

) -> Over[_T]:

return sqlalchemy.over(

element, partition_by=partition_by, order_by=order_by, range_=range_, rows=rows

) # type: ignore[arg-type]

def tuple_(

*clauses: Union[_ColumnExpressionArgument[Any], Any],

types: Optional[Sequence["_TypeEngineArgument[Any]"]] = None,

) -> Tuple[Any, ...]:

return sqlalchemy.tuple_(*clauses, types=types) # type: ignore[return-value]

def type_coerce(

expression: Union[_ColumnExpressionOrLiteralArgument[Any], Any],

type_: "_TypeEngineArgument[_T]",

) -> TypeCoerce[_T]:

return sqlalchemy.type_coerce(expression, type_) # type: ignore[arg-type]

def within_group(

element: FunctionElement[_T], *order_by: Union[_ColumnExpressionArgument[Any], Any]

) -> WithinGroup[_T]:

return sqlalchemy.within_group(element, *order_by) # type: ignore[arg-type]

# Separate this class in SelectBase, Select, and SelectOfScalar so that they can share

# where and having without having type overlap incompatibility in session.exec().

class SelectBase(_Select[Tuple[_T]]):

inherit_cache = True

def where(self, *whereclause: Union[_ColumnExpressionArgument[bool], bool]) -> Self:

"""Return a new `Select` construct with the given expression added to

its `WHERE` clause, joined to the existing clause via `AND`, if any.

"""

return super().where(*whereclause) # type: ignore[arg-type]

def having(self, *having: Union[_ColumnExpressionArgument[bool], bool]) -> Self:

"""Return a new `Select` construct with the given expression added to

its `HAVING` clause, joined to the existing clause via `AND`, if any.

"""

return super().having(*having) # type: ignore[arg-type]

class Select(SelectBase[_T]):

inherit_cache = True

# This is not comparable to sqlalchemy.sql.selectable.ScalarSelect, that has a different

# purpose. This is the same as a normal SQLAlchemy Select class where there's only one

# entity, so the result will be converted to a scalar by default. This way writing

# for loops on the results will feel natural.

class SelectOfScalar(SelectBase[_T]):

inherit_cache = True

_TCCA = Union[

TypedColumnsClauseRole[_T],

SQLCoreOperations[_T],

Type[_T],

]

# Generated TypeVars start

_TScalar_0 = TypeVar(

"_TScalar_0",

Column, # type: ignore

Sequence, # type: ignore

Mapping, # type: ignore

UUID,

datetime,

float,

int,

bool,

bytes,

str,

None,

)

_T0 = TypeVar("_T0")

_TScalar_1 = TypeVar(

"_TScalar_1",

Column, # type: ignore

Sequence, # type: ignore

Mapping, # type: ignore

UUID,

datetime,

float,

int,

bool,

bytes,

str,

None,

)

_T1 = TypeVar("_T1")

_TScalar_2 = TypeVar(

"_TScalar_2",

Column, # type: ignore

Sequence, # type: ignore

Mapping, # type: ignore

UUID,

datetime,

float,

int,

bool,

bytes,

str,

None,

)

_T2 = TypeVar("_T2")

_TScalar_3 = TypeVar(

"_TScalar_3",

Column, # type: ignore

Sequence, # type: ignore

Mapping, # type: ignore

UUID,

datetime,

float,

int,

bool,

bytes,

str,

None,

)

_T3 = TypeVar("_T3")

# Generated TypeVars end

@overload

def select(__ent0: _TScalar_0) -> SelectOfScalar[_TScalar_0]: # type: ignore

...

@overload

def select(__ent0: _TCCA[_T0]) -> SelectOfScalar[_T0]:

...

# Generated overloads start

@overload

def select( # type: ignore

entity_0: _TScalar_0,

entity_1: _TScalar_1,

) -> Select[Tuple[_TScalar_0, _TScalar_1]]:

...

@overload

def select( # type: ignore

entity_0: _TScalar_0,

__ent1: _TCCA[_T1],

) -> Select[Tuple[_TScalar_0, _T1]]:

...

@overload

def select( # type: ignore

__ent0: _TCCA[_T0],

entity_1: _TScalar_1,

) -> Select[Tuple[_T0, _TScalar_1]]:

...

@overload

def select( # type: ignore

__ent0: _TCCA[_T0],

__ent1: _TCCA[_T1],

) -> Select[Tuple[_T0, _T1]]:

...

@overload

def select( # type: ignore

entity_0: _TScalar_0,

entity_1: _TScalar_1,

entity_2: _TScalar_2,

) -> Select[Tuple[_TScalar_0, _TScalar_1, _TScalar_2]]:

...

@overload

def select( # type: ignore

entity_0: _TScalar_0,

entity_1: _TScalar_1,

__ent2: _TCCA[_T2],

) -> Select[Tuple[_TScalar_0, _TScalar_1, _T2]]:

...

@overload

def select( # type: ignore

entity_0: _TScalar_0,

__ent1: _TCCA[_T1],

entity_2: _TScalar_2,

) -> Select[Tuple[_TScalar_0, _T1, _TScalar_2]]:

...

@overload

def select( # type: ignore

entity_0: _TScalar_0,

__ent1: _TCCA[_T1],

__ent2: _TCCA[_T2],

) -> Select[Tuple[_TScalar_0, _T1, _T2]]:

...

@overload

def select( # type: ignore

__ent0: _TCCA[_T0],

entity_1: _TScalar_1,

entity_2: _TScalar_2,

) -> Select[Tuple[_T0, _TScalar_1, _TScalar_2]]:

...

@overload

def select( # type: ignore

__ent0: _TCCA[_T0],

entity_1: _TScalar_1,

__ent2: _TCCA[_T2],

) -> Select[Tuple[_T0, _TScalar_1, _T2]]:

...

@overload

def select( # type: ignore

__ent0: _TCCA[_T0],

__ent1: _TCCA[_T1],

entity_2: _TScalar_2,

) -> Select[Tuple[_T0, _T1, _TScalar_2]]:

...

@overload

def select( # type: ignore

__ent0: _TCCA[_T0],

__ent1: _TCCA[_T1],

__ent2: _TCCA[_T2],

) -> Select[Tuple[_T0, _T1, _T2]]:

...

@overload

def select( # type: ignore

entity_0: _TScalar_0,

entity_1: _TScalar_1,

entity_2: _TScalar_2,

entity_3: _TScalar_3,

) -> Select[Tuple[_TScalar_0, _TScalar_1, _TScalar_2, _TScalar_3]]:

...

@overload

def select( # type: ignore

entity_0: _TScalar_0,

entity_1: _TScalar_1,

entity_2: _TScalar_2,

__ent3: _TCCA[_T3],

) -> Select[Tuple[_TScalar_0, _TScalar_1, _TScalar_2, _T3]]:

...

@overload

def select( # type: ignore

entity_0: _TScalar_0,

entity_1: _TScalar_1,

__ent2: _TCCA[_T2],

entity_3: _TScalar_3,

) -> Select[Tuple[_TScalar_0, _TScalar_1, _T2, _TScalar_3]]:

...

@overload

def select( # type: ignore

entity_0: _TScalar_0,

entity_1: _TScalar_1,

__ent2: _TCCA[_T2],

__ent3: _TCCA[_T3],

) -> Select[Tuple[_TScalar_0, _TScalar_1, _T2, _T3]]:

...

@overload

def select( # type: ignore

entity_0: _TScalar_0,

__ent1: _TCCA[_T1],

entity_2: _TScalar_2,

entity_3: _TScalar_3,

) -> Select[Tuple[_TScalar_0, _T1, _TScalar_2, _TScalar_3]]:

...

@overload

def select( # type: ignore

entity_0: _TScalar_0,

__ent1: _TCCA[_T1],

entity_2: _TScalar_2,

__ent3: _TCCA[_T3],

) -> Select[Tuple[_TScalar_0, _T1, _TScalar_2, _T3]]:

...

@overload

def select( # type: ignore

entity_0: _TScalar_0,

__ent1: _TCCA[_T1],

__ent2: _TCCA[_T2],

entity_3: _TScalar_3,

) -> Select[Tuple[_TScalar_0, _T1, _T2, _TScalar_3]]:

...

@overload

def select( # type: ignore

entity_0: _TScalar_0,

__ent1: _TCCA[_T1],

__ent2: _TCCA[_T2],

__ent3: _TCCA[_T3],

) -> Select[Tuple[_TScalar_0, _T1, _T2, _T3]]:

...

@overload

def select( # type: ignore

__ent0: _TCCA[_T0],

entity_1: _TScalar_1,

entity_2: _TScalar_2,

entity_3: _TScalar_3,

) -> Select[Tuple[_T0, _TScalar_1, _TScalar_2, _TScalar_3]]:

...

@overload

def select( # type: ignore

__ent0: _TCCA[_T0],

entity_1: _TScalar_1,

entity_2: _TScalar_2,

__ent3: _TCCA[_T3],

) -> Select[Tuple[_T0, _TScalar_1, _TScalar_2, _T3]]:

...

@overload

def select( # type: ignore

__ent0: _TCCA[_T0],

entity_1: _TScalar_1,

__ent2: _TCCA[_T2],

entity_3: _TScalar_3,

) -> Select[Tuple[_T0, _TScalar_1, _T2, _TScalar_3]]:

...

@overload

def select( # type: ignore

__ent0: _TCCA[_T0],

entity_1: _TScalar_1,

__ent2: _TCCA[_T2],

__ent3: _TCCA[_T3],

) -> Select[Tuple[_T0, _TScalar_1, _T2, _T3]]:

...

@overload

def select( # type: ignore

__ent0: _TCCA[_T0],

__ent1: _TCCA[_T1],

entity_2: _TScalar_2,

entity_3: _TScalar_3,

) -> Select[Tuple[_T0, _T1, _TScalar_2, _TScalar_3]]:

...

@overload

def select( # type: ignore

__ent0: _TCCA[_T0],

__ent1: _TCCA[_T1],

entity_2: _TScalar_2,

__ent3: _TCCA[_T3],

) -> Select[Tuple[_T0, _T1, _TScalar_2, _T3]]:

...

@overload

def select( # type: ignore

__ent0: _TCCA[_T0],

__ent1: _TCCA[_T1],

__ent2: _TCCA[_T2],

entity_3: _TScalar_3,

) -> Select[Tuple[_T0, _T1, _T2, _TScalar_3]]:

...

@overload

def select( # type: ignore

__ent0: _TCCA[_T0],

__ent1: _TCCA[_T1],

__ent2: _TCCA[_T2],

__ent3: _TCCA[_T3],

) -> Select[Tuple[_T0, _T1, _T2, _T3]]:

...

# Generated overloads end

def select(*entities: Any) -> Union[Select, SelectOfScalar]: # type: ignore

if len(entities) == 1:

return SelectOfScalar(*entities)

return Select(*entities)

def col(column_expression: _T) -> Mapped[_T]:

if not isinstance(column_expression, (ColumnClause, Column, InstrumentedAttribute)):

raise RuntimeError(f"Not a SQLAlchemy column: {column_expression}")

return column_expression # type: ignore

python-sqlmodel/sqlmodel/sql/expression.py at main · bryanchance/python-sqlmodel · GitHub

Repository navigation

Expand file tree

Breadcrumbs

expression.py

Latest commit

History

Breadcrumbs

expression.py

File metadata and controls