Add boilerplate code for new asymmetry field as property of a class

Summary:
This diff only adds the plumbing. In the next diff, we will implement the algorithm.

Issue: #3299

Reviewed By: yangdanny97

Differential Revision: D104536804

fbshipit-source-id: ebefd7865495198ff6939fd9f79d1d90bdabeda2

Author: migeed-z

pyrefly/lib/alt/class/classdef.rs

@@ -30,6 +30,7 @@ use crate::binding::binding::KeyClassBaseType;
 use crate::binding::binding::KeyClassField;
 use crate::binding::binding::KeyClassMetadata;
 use crate::binding::binding::KeyClassMro;
+use crate::binding::binding::KeyClassSubscriptSymmetry;
 use crate::error::collector::ErrorCollector;
 use crate::types::callable::Param;
 use crate::types::callable::Required;
@@ -106,6 +107,11 @@ impl<'a, Ans: LookupAnswer> AnswersSolver<'a, Ans> {
             .unwrap_or_else(|| Arc::new(AbstractClassMembers::recursive()))
     }
 
+    pub fn get_subscript_symmetry_for_class(&self, cls: &Class) -> Arc<bool> {
+        self.get_from_class(cls, &KeyClassSubscriptSymmetry(cls.index()))
+            .unwrap_or_else(|| Arc::new(true))
+    }
+
     pub fn get_base_types_for_class(&self, cls: &Class) -> Arc<ClassBases> {
         self.get_from_class(cls, &KeyClassBaseType(cls.index()))
             .unwrap_or_else(|| Arc::new(ClassBases::recursive()))

pyrefly/lib/alt/traits.rs

@@ -37,6 +37,7 @@ use crate::binding::binding::BindingClassBaseType;
 use crate::binding::binding::BindingClassField;
 use crate::binding::binding::BindingClassMetadata;
 use crate::binding::binding::BindingClassMro;
+use crate::binding::binding::BindingClassSubscriptSymmetry;
 use crate::binding::binding::BindingClassSynthesizedFields;
 use crate::binding::binding::BindingConsistentOverrideCheck;
 use crate::binding::binding::BindingDecoratedFunction;
@@ -61,6 +62,7 @@ use crate::binding::binding::KeyClassBaseType;
 use crate::binding::binding::KeyClassField;
 use crate::binding::binding::KeyClassMetadata;
 use crate::binding::binding::KeyClassMro;
+use crate::binding::binding::KeyClassSubscriptSymmetry;
 use crate::binding::binding::KeyClassSynthesizedFields;
 use crate::binding::binding::KeyConsistentOverrideCheck;
 use crate::binding::binding::KeyDecoratedFunction;
@@ -494,6 +496,22 @@ impl<Ans: LookupAnswer> Solve<Ans> for KeyAbstractClassCheck {
     }
 }
 
+impl<Ans: LookupAnswer> Solve<Ans> for KeyClassSubscriptSymmetry {
+    fn solve(
+        _answers: &AnswersSolver<Ans>,
+        _binding: &BindingClassSubscriptSymmetry,
+        _range: TextRange,
+        _errors: &ErrorCollector,
+    ) -> Arc<bool> {
+        // TODO: implement algorithm
+        Arc::new(true)
+    }
+
+    fn promote_recursive(_heap: &TypeHeap, _: Var) -> Self::Answer {
+        true
+    }
+}
+
 impl<Ans: LookupAnswer> Solve<Ans> for KeyLegacyTypeParam {
     fn solve(
         answers: &AnswersSolver<Ans>,

pyrefly/lib/binding/binding.rs

@@ -102,6 +102,7 @@ assert_bytes!(KeyAnnotation, 12);
 assert_bytes!(KeyClassMetadata, 4);
 assert_bytes!(KeyClassMro, 4);
 assert_bytes!(KeyAbstractClassCheck, 4);
+assert_bytes!(KeyClassSubscriptSymmetry, 4);
 assert_words!(KeyLegacyTypeParam, 1);
 assert_words!(KeyYield, 1);
 assert_words!(KeyYieldFrom, 1);
@@ -119,6 +120,7 @@ assert_words!(BindingClassBaseType, 3);
 assert_words!(BindingClassMetadata, 11);
 assert_bytes!(BindingClassMro, 4);
 assert_bytes!(BindingAbstractClassCheck, 4);
+assert_bytes!(BindingClassSubscriptSymmetry, 4);
 assert_words!(BindingClassField, 11);
 assert_bytes!(BindingClassSynthesizedFields, 4);
 assert_bytes!(BindingLegacyTypeParam, 16);
@@ -150,6 +152,7 @@ pub enum AnyIdx {
     KeyClassMetadata(Idx<KeyClassMetadata>),
     KeyClassMro(Idx<KeyClassMro>),
     KeyAbstractClassCheck(Idx<KeyAbstractClassCheck>),
+    KeyClassSubscriptSymmetry(Idx<KeyClassSubscriptSymmetry>),
     KeyLegacyTypeParam(Idx<KeyLegacyTypeParam>),
     KeyYield(Idx<KeyYield>),
     KeyYieldFrom(Idx<KeyYieldFrom>),
@@ -225,6 +228,9 @@ macro_rules! dispatch_anyidx {
             AnyIdx::KeyAbstractClassCheck(idx) => {
                 $self.$method::<$crate::binding::binding::KeyAbstractClassCheck>(*idx)
             }
+            AnyIdx::KeyClassSubscriptSymmetry(idx) => {
+                $self.$method::<$crate::binding::binding::KeyClassSubscriptSymmetry>(*idx)
+            }
             AnyIdx::KeyLegacyTypeParam(idx) => {
                 $self.$method::<$crate::binding::binding::KeyLegacyTypeParam>(*idx)
             }
@@ -295,6 +301,9 @@ macro_rules! dispatch_anyidx {
             AnyIdx::KeyAbstractClassCheck(idx) => {
                 $self.$method::<$crate::binding::binding::KeyAbstractClassCheck>(*idx, $($args),+)
             }
+            AnyIdx::KeyClassSubscriptSymmetry(idx) => {
+                $self.$method::<$crate::binding::binding::KeyClassSubscriptSymmetry>(*idx, $($args),+)
+            }
             AnyIdx::KeyLegacyTypeParam(idx) => {
                 $self.$method::<$crate::binding::binding::KeyLegacyTypeParam>(*idx, $($args),+)
             }
@@ -334,6 +343,7 @@ impl DisplayWith<Bindings> for AnyIdx {
             Self::KeyClassMetadata(idx) => write!(f, "{}", ctx.display(*idx)),
             Self::KeyClassMro(idx) => write!(f, "{}", ctx.display(*idx)),
             Self::KeyAbstractClassCheck(idx) => write!(f, "{}", ctx.display(*idx)),
+            Self::KeyClassSubscriptSymmetry(idx) => write!(f, "{}", ctx.display(*idx)),
             Self::KeyLegacyTypeParam(idx) => write!(f, "{}", ctx.display(*idx)),
             Self::KeyYield(idx) => write!(f, "{}", ctx.display(*idx)),
             Self::KeyYieldFrom(idx) => write!(f, "{}", ctx.display(*idx)),
@@ -354,6 +364,7 @@ pub enum AnyExportedKey {
     KeyClassMetadata(KeyClassMetadata),
     KeyClassMro(KeyClassMro),
     KeyAbstractClassCheck(KeyAbstractClassCheck),
+    KeyClassSubscriptSymmetry(KeyClassSubscriptSymmetry),
     KeyTypeAlias(KeyTypeAlias),
 }
 
@@ -741,6 +752,28 @@ impl Exported for KeyAbstractClassCheck {
         AnyExportedKey::KeyAbstractClassCheck(self.clone())
     }
 }
+impl Keyed for KeyClassSubscriptSymmetry {
+    const EXPORTED: bool = true;
+    type Value = BindingClassSubscriptSymmetry;
+    type Answer = bool;
+    fn to_anyidx(idx: Idx<Self>) -> AnyIdx {
+        AnyIdx::KeyClassSubscriptSymmetry(idx)
+    }
+    fn range_with(idx: Idx<Self>, bindings: &Bindings) -> TextRange
+    where
+        BindingTable: TableKeyed<Self, Value = BindingEntry<Self>>,
+    {
+        bindings.idx_to_key(bindings.get(idx).class_idx).range()
+    }
+    fn try_to_anykey(&self) -> Option<AnyExportedKey> {
+        Some(AnyExportedKey::KeyClassSubscriptSymmetry(self.clone()))
+    }
+}
+impl Exported for KeyClassSubscriptSymmetry {
+    fn to_anykey(&self) -> AnyExportedKey {
+        AnyExportedKey::KeyClassSubscriptSymmetry(self.clone())
+    }
+}
 impl Keyed for KeyLegacyTypeParam {
     type Value = BindingLegacyTypeParam;
     type Answer = LegacyTypeParameterLookup;
@@ -1599,6 +1632,15 @@ impl DisplayWith<ModuleInfo> for KeyAbstractClassCheck {
     }
 }
 
+#[derive(Clone, Debug, PartialEq, Eq, Hash)]
+pub struct KeyClassSubscriptSymmetry(pub ClassDefIndex);
+
+impl DisplayWith<ModuleInfo> for KeyClassSubscriptSymmetry {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>, _ctx: &ModuleInfo) -> fmt::Result {
+        write!(f, "KeyClassSubscriptSymmetry(class{})", self.0)
+    }
+}
+
 #[derive(Clone, Debug, PartialEq, Eq, Hash)]
 pub struct KeyLegacyTypeParam(pub ShortIdentifier);
 
@@ -3118,6 +3160,21 @@ impl DisplayWith<Bindings> for BindingAbstractClassCheck {
     }
 }
 
+#[derive(Clone, Debug)]
+pub struct BindingClassSubscriptSymmetry {
+    pub class_idx: Idx<KeyClass>,
+}
+
+impl DisplayWith<Bindings> for BindingClassSubscriptSymmetry {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>, ctx: &Bindings) -> fmt::Result {
+        write!(
+            f,
+            "BindingClassSubscriptSymmetry({})",
+            ctx.display(self.class_idx)
+        )
+    }
+}
+
 #[derive(Clone, Debug)]
 /// A legacy type parameter (`T = typing.TypeVar("T")`).
 pub enum BindingLegacyTypeParam {

pyrefly/lib/binding/class.rs

@@ -44,6 +44,7 @@ use crate::binding::binding::BindingClassBaseType;
 use crate::binding::binding::BindingClassField;
 use crate::binding::binding::BindingClassMetadata;
 use crate::binding::binding::BindingClassMro;
+use crate::binding::binding::BindingClassSubscriptSymmetry;
 use crate::binding::binding::BindingClassSynthesizedFields;
 use crate::binding::binding::BindingConsistentOverrideCheck;
 use crate::binding::binding::BindingExpect;
@@ -62,6 +63,7 @@ use crate::binding::binding::KeyClassBaseType;
 use crate::binding::binding::KeyClassField;
 use crate::binding::binding::KeyClassMetadata;
 use crate::binding::binding::KeyClassMro;
+use crate::binding::binding::KeyClassSubscriptSymmetry;
 use crate::binding::binding::KeyClassSynthesizedFields;
 use crate::binding::binding::KeyConsistentOverrideCheck;
 use crate::binding::binding::KeyExpect;
@@ -135,6 +137,7 @@ impl<'a> BindingsBuilder<'a> {
             consistent_override_check_idx: self
                 .idx_for_promise(KeyConsistentOverrideCheck(def_index)),
             abstract_class_check_idx: self.idx_for_promise(KeyAbstractClassCheck(def_index)),
+            subscript_symmetry_idx: self.idx_for_promise(KeyClassSubscriptSymmetry(def_index)),
         };
         (class_object, class_indices)
     }
@@ -545,6 +548,12 @@ impl<'a> BindingsBuilder<'a> {
                 class_idx: class_indices.class_idx,
             },
         );
+        self.insert_binding_idx(
+            class_indices.subscript_symmetry_idx,
+            BindingClassSubscriptSymmetry {
+                class_idx: class_indices.class_idx,
+            },
+        );
     }
 
     /// Extracts docstrings for each field, mapping the field's range to the docstring's range.
@@ -1053,6 +1062,12 @@ impl<'a> BindingsBuilder<'a> {
                 class_idx: class_indices.class_idx,
             },
         );
+        self.insert_binding_idx(
+            class_indices.subscript_symmetry_idx,
+            BindingClassSubscriptSymmetry {
+                class_idx: class_indices.class_idx,
+            },
+        );
     }
 
     pub fn synthesize_enum_def(

pyrefly/lib/binding/scope.rs

@@ -50,6 +50,7 @@ use crate::binding::binding::KeyClass;
 use crate::binding::binding::KeyClassBaseType;
 use crate::binding::binding::KeyClassMetadata;
 use crate::binding::binding::KeyClassMro;
+use crate::binding::binding::KeyClassSubscriptSymmetry;
 use crate::binding::binding::KeyClassSynthesizedFields;
 use crate::binding::binding::KeyConsistentOverrideCheck;
 use crate::binding::binding::KeyDecoratedFunction;
@@ -896,6 +897,7 @@ pub struct ClassIndices {
     pub variance_check_idx: Idx<KeyVarianceCheck>,
     pub consistent_override_check_idx: Idx<KeyConsistentOverrideCheck>,
     pub abstract_class_check_idx: Idx<KeyAbstractClassCheck>,
+    pub subscript_symmetry_idx: Idx<KeyClassSubscriptSymmetry>,
 }
 
 #[derive(Clone, Debug)]

pyrefly/lib/binding/table.rs

@@ -44,6 +44,7 @@ macro_rules! table {
             $($vis)* class_metadata: $t<$crate::binding::binding::KeyClassMetadata>,
             $($vis)* class_mros: $t<$crate::binding::binding::KeyClassMro>,
             $($vis)* abstract_class_check: $t<$crate::binding::binding::KeyAbstractClassCheck>,
+            $($vis)* class_subscript_symmetry: $t<$crate::binding::binding::KeyClassSubscriptSymmetry>,
             $($vis)* legacy_tparams: $t<$crate::binding::binding::KeyLegacyTypeParam>,
             $($vis)* yields: $t<$crate::binding::binding::KeyYield>,
             $($vis)* yield_froms: $t<$crate::binding::binding::KeyYieldFrom>,
@@ -169,6 +170,12 @@ macro_rules! table {
             fn get_mut(&mut self) -> &mut Self::Value { &mut self.abstract_class_check }
         }
 
+        impl $crate::binding::table::TableKeyed<$crate::binding::binding::KeyClassSubscriptSymmetry> for $name {
+            type Value = $t<$crate::binding::binding::KeyClassSubscriptSymmetry>;
+            fn get(&self) -> &Self::Value { &self.class_subscript_symmetry }
+            fn get_mut(&mut self) -> &mut Self::Value { &mut self.class_subscript_symmetry }
+        }
+
         impl $crate::binding::table::TableKeyed<$crate::binding::binding::KeyLegacyTypeParam> for $name {
             type Value = $t<$crate::binding::binding::KeyLegacyTypeParam>;
             fn get(&self) -> &Self::Value { &self.legacy_tparams }
@@ -230,6 +237,7 @@ macro_rules! table_for_each(
         $f(&($e).class_metadata);
         $f(&($e).class_mros);
         $f(&($e).abstract_class_check);
+        $f(&($e).class_subscript_symmetry);
         $f(&($e).legacy_tparams);
         $f(&($e).yields);
         $f(&($e).yield_froms);
@@ -259,6 +267,7 @@ macro_rules! table_mut_for_each(
         $f(&mut ($e).class_metadata);
         $f(&mut ($e).class_mros);
         $f(&mut ($e).abstract_class_check);
+        $f(&mut ($e).class_subscript_symmetry);
         $f(&mut ($e).legacy_tparams);
         $f(&mut ($e).yields);
         $f(&mut ($e).yield_froms);
@@ -288,6 +297,7 @@ macro_rules! table_try_for_each(
         $f(&($e).class_metadata)?;
         $f(&($e).class_mros)?;
         $f(&($e).abstract_class_check)?;
+        $f(&($e).class_subscript_symmetry)?;
         $f(&($e).legacy_tparams)?;
         $f(&($e).yields)?;
         $f(&($e).yield_froms)?;

pyrefly/lib/state/state.rs

@@ -90,6 +90,7 @@ use crate::binding::binding::KeyClassBaseType;
 use crate::binding::binding::KeyClassField;
 use crate::binding::binding::KeyClassMetadata;
 use crate::binding::binding::KeyClassMro;
+use crate::binding::binding::KeyClassSubscriptSymmetry;
 use crate::binding::binding::KeyClassSynthesizedFields;
 use crate::binding::binding::KeyExport;
 use crate::binding::binding::KeyTParams;
@@ -313,7 +314,8 @@ impl ModuleDeps {
             | AnyExportedKey::KeyVariance(KeyVariance(c))
             | AnyExportedKey::KeyClassMetadata(KeyClassMetadata(c))
             | AnyExportedKey::KeyClassMro(KeyClassMro(c))
-            | AnyExportedKey::KeyAbstractClassCheck(KeyAbstractClassCheck(c)) => {
+            | AnyExportedKey::KeyAbstractClassCheck(KeyAbstractClassCheck(c))
+            | AnyExportedKey::KeyClassSubscriptSymmetry(KeyClassSubscriptSymmetry(c)) => {
                 self.classes.insert(c);
             }
         }