Struct ProgramFile 

pub struct ProgramFile<'db>(/* private fields */);

A file interpreted within a particular Python program.

The same file can participate in multiple programs, each with different Python versions, search paths, or other settings that affect type inference.

For example:

project/
├── app.py         # Project program: Python 3.11
├── generate.py    # Script program:  Python 3.12
└── shared.py      # Imported by both

In shared.py, version-dependent code can produce different types:

import sys

if sys.version_info >= (3, 12):
    value = 1
else:
    value = "one"

The two interpretations therefore need separate semantic identities:

ProgramFile(shared.py, project program) -> value: str
ProgramFile(shared.py, script program)  -> value: int

Semantic queries, such as semantic_index, use ProgramFile to avoid sharing results between incompatible programs. Lower-level operations use narrower identities where possible:

program_file.python_file(db)   -> File + Python version
program_file.resolver_file(db) -> File + resolver environment

This allows programs with the same Python version to share parsed syntax, and programs with equivalent resolver environments to share module resolution, while keeping type inference isolated.

Implementations

impl ProgramFile<'static>

pub fn ingredient(zalsa: &Zalsa) -> &IngredientImpl<Self>

impl<'db> ProgramFile<'db>

pub fn new_internal<Db_, T0: Lookup<PythonFile<'db>> + Hash, T1: Lookup<Program<'db>> + Hash>( db: &'db Db_, python_file: T0, program: T1, ) -> Self

where Db_: ?Sized + Database, PythonFile<'db>: HashEqLike<T0>, Program<'db>: HashEqLike<T1>,

pub fn python_file<Db_>(self, db: &'db Db_) -> PythonFile<'db>

where Db_: ?Sized + Database,

Cache the parser key even though its Python version is redundant with program: program files are created infrequently, but their parser keys are looked up extensively.

pub fn program<Db_>(self, db: &'db Db_) -> Program<'db>

where Db_: ?Sized + Database,

impl ProgramFile<'_>

pub fn default_debug_fmt(this: Self, f: &mut Formatter<'_>) -> Result

where for<'db> PythonFile<'db>: Debug, for<'db> Program<'db>: Debug,

Default debug formatting for this struct (may be useful if you define your own Debug impl)

impl<'db> ProgramFile<'db>

pub fn new(db: &'db dyn Db, file: File, program: Program<'db>) -> Self

pub fn file(self, db: &'db dyn Db) -> File

Returns the physical file represented by this program file.

pub fn resolver_environment(self, db: &'db dyn Db) -> ResolverEnvironment<'db>

Returns the module-resolution environment for this program file.

pub fn resolver_file(self, db: &'db dyn Db) -> ResolverFile<'db>

Returns the resolver key for this file.

pub fn python_version(self, db: &'db dyn Db) -> PythonVersion

Returns the Python version associated with this file’s program.

Trait Implementations

impl<'db> AsId for ProgramFile<'db>

fn as_id(&self) -> Id

impl<'db> Clone for ProgramFile<'db>

fn clone(&self) -> ProgramFile<'db>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Configuration for ProgramFile<'static>

const LOCATION: Location

const DEBUG_NAME: &'static str = "ProgramFile"

const PERSIST: bool = false

Whether this struct should be persisted with the database.

type Fields<'a> = (PythonFile<'a>, Program<'a>)

The fields of the struct being interned.

type Struct<'db> = ProgramFile<'db>

The end user struct

fn heap_size(value: &Self::Fields<'_>) -> Option<usize>

Returns the size of any heap allocations in the output value, in bytes.

fn serialize<S: Serializer>( fields: &Self::Fields<'_>, serializer: S, ) -> Result<S::Ok, S::Error>

Serialize the fields using serde.

fn deserialize<'de, D: Deserializer<'de>>( deserializer: D, ) -> Result<Self::Fields<'static>, D::Error>

Deserialize the fields using serde.

const REVISIONS: NonZero<usize> = _

impl<'db> Copy for ProgramFile<'db>

impl<'db> Debug for ProgramFile<'db>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'db> Eq for ProgramFile<'db>

impl<'db> FromId for ProgramFile<'db>

fn from_id(id: Id) -> Self

impl GetSize for ProgramFile<'_>

fn get_stack_size() -> usize

Determines how may bytes this object occupies inside the stack.

fn get_heap_size(&self) -> usize

Determines how many bytes this object occupies inside the heap.

fn get_heap_size_with_tracker<T>(&self, tracker: T) -> (usize, T)

where T: GetSizeTracker,

Determines how many bytes this object occupies inside the heap while using a tracker.

fn get_size(&self) -> usize

Determines the total size of the object.

fn get_size_with_tracker<T>(&self, tracker: T) -> (usize, T)

where T: GetSizeTracker,

Determines the total size of the object while using a tracker.

impl<'db> HasJar for ProgramFile<'db>

const KIND: JarKind = zalsa_::JarKind::Struct

The [JarKind] for Self::Jar.

type Jar = JarImpl<ProgramFile<'static>>

The [Jar] associated with this ingredient.

impl<'db> Hash for ProgramFile<'db>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'db> PartialEq for ProgramFile<'db>

fn eq(&self, other: &ProgramFile<'db>) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'db> SalsaStructInDb for ProgramFile<'db>

const LEAF_TYPE_IDS: &'static [ConstTypeId]

The type IDs of all concrete (leaf) salsa struct types that this type can contain.

type MemoIngredientMap = MemoIngredientSingletonIndex

fn lookup_ingredient_index(aux: &Zalsa) -> IngredientIndices

Lookup or create ingredient indices.

fn entries(zalsa: &Zalsa) -> impl Iterator<Item = DatabaseKeyIndex> + '_

Returns the IDs of any instances of this struct in the database.

fn cast(id: Id, type_id: TypeId) -> Option<Self>

Plumbing to support nested salsa supertypes.

unsafe fn memo_table( zalsa: &Zalsa, id: Id, current_revision: Revision, ) -> MemoTableWithTypes<'_>

Return the memo table associated with id.

impl<'db> SalsaValue for ProgramFile<'db>

impl<'db> Send for ProgramFile<'db>

impl<'db> StructuralPartialEq for ProgramFile<'db>

impl<'db> Sync for ProgramFile<'db>