[MNT]: Decide on a standard abbreviation for transforms when used as local variables #22156

Activity

1. anntzer

   added

   Maintenance

   on Jan 8, 2022
2. jklymak commented on Jan 8, 2022

   

   jklymak

   on Jan 8, 2022

   Member

   More actions

   Mildly prefer trans. I'll also note that is what Agg appears to use.

   👍React with 👍1Reacted by Phil Elson
3. timhoffm commented on Jan 8, 2022

   

   timhoffm

   on Jan 8, 2022

   Member

   More actions

   How about trafo?
4. pedrompecanha commented on Sep 21, 2023

   

   pedrompecanha

   on Sep 21, 2023

   Contributor

   More actions

   Hey guys! So, to understand it better, inside the code, there are lots of local variables that refer to transforms. There is not a pattern on how to reference this transform in the variable name. So, to solve this, one would have to dig into the code and standardize everything. Is that right?
   With that being said, I prefer trans :)
5. story645 commented on Sep 21, 2023

   

   story645

   on Sep 21, 2023

   Member

   More actions

   So, to solve this, one would have to dig into the code and standardize everything. Is that right?

   Basically - the idea is that then if you search the code for the variable you'll hopefully find basically all the places in the code where a transform object is created/modified/etc.
6. Arikad0 commented on Oct 18, 2023

   

   Arikad0

   on Oct 18, 2023

   More actions

   So, the objective is change the offset_transform occurences to any abreviation decided here? about the decision, I prefer trans
7. story645 commented on Oct 19, 2023

   

   story645

   on Oct 19, 2023

   Last edited by story645

   Member

   More actions

   So, the objective is change the offset_transform occurences to any abreviation decided here? about the decision, I prefer trans

   It's to change local internal variable names for transform objects to trans (or whichever abbreviation has consensus). For example:

   trf = transform.transform_offset()

   to

   trans = transform.transform_offset()
8. ivanov commented on Oct 19, 2023

   

   ivanov

   on Oct 19, 2023

   Member

   More actions

   I read trf as tee-are-eff and it makes me go double-u-tee-eff is that? 😅

   trans is OK, and consistent with transData and transAxes, though really is transform so long? At the same time, in most places, we could even shorten it to just t or tf or trf, if necessary, as a prefix or a suffix, since the word transform is either there to get the thing when it is being assigned, or is the method called on the thing when it is being used. And yet another option would be to not assign to a variable at all, since it is rarely used more than once.

   Here's a reasonable example from the code of a Quiver method which currently reads like this:

       def get_datalim(self, transData):
           trans = self.get_transform()
           offset_trf = self.get_offset_transform()
           full_transform = (trans - transData) + (offset_trf - transData)
           XY = full_transform.transform(self.XY)

   What would you want to change this to?

   some options

       def get_datalim(self, transData):
           t = self.get_transform()
           offset_t = self.get_offset_transform()
           full_t = (t - transData) + (offset_t - transData)
           XY = full_t.transform(self.XY)

       def get_datalim(self, transData):
           trans = self.get_transform()
           transOffset = self.get_offset_transform()
           transFull = (trans - transData) + (transOffset - transData)
           XY = transFull.transform(self.XY)

       def get_datalim(self, transData):
           full_transform = (self.get_transform() - transData) + (self.get_offset_transform() - transData)
           XY = full_transform.transform(self.XY)
9. tacaswell commented on Oct 26, 2023

   

   tacaswell

   on Oct 26, 2023

   Member

   More actions

   The consensus on the call is that:

   • we should prefer trans being in local variable names
   • as code is touched, it can be converted
   • we are not interested in PRs that only rename local variables

   👍React with 👍1Reacted by Paul Ivanov
10. timhoffm commented on Sep 15, 2025

    

    timhoffm

    on Sep 15, 2025

    Member

    More actions

    Closing as completed. The convention is documented at https://matplotlib.org/devdocs/devel/coding_guide.html#variable-names
11. timhoffm

    closed this as completedon Sep 15, 2025
12. QuLogic

    added this to the v3.8-doc milestone on Sep 15, 2025