Skip to content

Some fixes to eval() in Function subclasses #23526

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
May 20, 2022
Merged

Some fixes to eval() in Function subclasses #23526

merged 3 commits into from
May 20, 2022

Conversation

asmeurer
Copy link
Member

@asmeurer asmeurer commented May 19, 2022 •
edited
Loading

  • Made the return value of eval() automatically sympified (so things like return 1 will result in Integer(1)).
  • Includes some fixes to 3-argument pow in the code that were necessary after this.
  • Raise an exception if eval is not defined as a @classmethod (common mistake).

References to other Issues or PRs

Brief description of what is fixed or changed

Other comments

Release Notes

  • core
    • The return values of eval on Function subclasses are now automatically sympified.
    • Function subclasses now raise an exception if the eval method is not defined as a @classmethod.

asmeurer added 3 commits May 19, 2022 15:29
@asmeurer
Make sure 3-argument pow() is always called with ints
41aa2dc 
Python does not allow overriding 3-arg pow() when the first argument is an int
(see https://docs.python.org/3/reference/datamodel.html#object.__rpow__), so
if the second or thired argument can be a SymPy Integer, we need to make sure
they are converted to int first.
@asmeurer
Automatically sympify the result of eval() in Function subclasses
67f9561 
This makes it so that something like

class f(Function):
    @classmethod
    def eval(cls, x):
        return 1

returns Integer(1) instead of int(1).
@asmeurer
Check that eval() is a class method in the Function metaclass
fcfa20d 
This makes the following incorrect code fail automatically.

class f(Function):
    def eval(self, x): # Should be a @classmethod
        pass
@sympy-bot
Copy link

sympy-bot commented May 19, 2022 •
edited
Loading

✅

Hi, I am the SymPy bot (v167). I'm here to help you write a release notes entry. Please read the guide on how to write release notes.

Your release notes are in good order.

Here is what the release notes will look like:

  • core

    • The return values of eval on Function subclasses are now automatically sympified. (#23526 by @asmeurer)

    • Function subclasses now raise an exception if the eval method is not defined as a @classmethod. (#23526 by @asmeurer)

This will be added to https://github.com/sympy/sympy/wiki/Release-Notes-for-1.11.

Click here to see the pull request description that was parsed. 
<!-- Your title above should be a short description of what
was changed. Do not include the issue number in the title. -->

- Made the return value of `eval()` automatically sympified (so things like `return 1` will result in `Integer(1)`).
- Includes some fixes to 3-argument `pow` in the code that were necessary after this.
- Raise an exception if `eval` is not defined as a `@classmethod` (common mistake).


#### References to other Issues or PRs
<!-- If this pull request fixes an issue, write "Fixes #NNNN" in that exact
format, e.g. "Fixes #1234" (see
https://tinyurl.com/auto-closing for more information). Also, please
write a comment on that issue linking back to this pull request once it is
open. -->

#### Brief description of what is fixed or changed


#### Other comments


#### Release Notes

<!-- Write the release notes for this release below between the BEGIN and END
statements. The basic format is a bulleted list with the name of the subpackage
and the release note for this PR. For example:

* solvers
  * Added a new solver for logarithmic equations.

* functions
  * Fixed a bug with log of integers.

or if no release note(s) should be included use:

NO ENTRY

See https://github.com/sympy/sympy/wiki/Writing-Release-Notes for more
information on how to write release notes. The bot will check your release
notes automatically to see if they are formatted correctly. -->

<!-- BEGIN RELEASE NOTES -->
- core
  - The return values of `eval` on `Function` subclasses are now automatically sympified.
  - `Function` subclasses now raise an exception if the `eval` method is not defined as a `@classmethod`.
<!-- END RELEASE NOTES -->

Update

The release notes on the wiki have been updated.

@github-actions
Copy link

Benchmark results from GitHub Actions

Lower numbers are good, higher numbers are bad. A ratio less than 1
means a speed up and greater than 1 means a slowdown. Green lines
beginning with + are slowdowns (the PR is slower then master or
master is slower than the previous release). Red lines beginning
with - are speedups.

Significantly changed benchmark results (PR vs master)



Significantly changed benchmark results (master vs previous release)


       before           after         ratio
     [77f1d79c]       [b418faaa]
     <sympy-1.10.1^0>                 
+      98.7±0.4ms        179±0.5ms     1.81  sum.TimeSum.time_doit



Full benchmark results can be found as artifacts in GitHub Actions

(click on checks at the top of the PR).

      		
    

  





        


            

            
            

              
            

        

      


      

            
  
  

    
  
    
    

  

  

  


    












      

  
      



  

  @oscarbenjamin





  



    

      

  

    

        
    
    

  


      
          
  
      
            Copy link

  

      
    

  


  

      

  
    Collaborator


      

  


  

    

  





      


        



  
    

      
          
Looks good

      		
    

  





        


            

            
            

              
            

        

      


      

            
  
  

    
  
    
    

  

  

  


    












      

  
            


  
 
  

    
  

  



        @asmeurer
  asmeurer



        merged commit 1e09ff9
      into

      
  
    sympy:master
  


    May 20, 2022

  







  

  

    
  


  

      


    @utensil
utensil



    mentioned this pull request
    
      Mar 31, 2024
    





  


  

      

  
  Open

  







  













  
  

    

      

  




      


    


    

      

        
      

  
    Sign up for free
    to join this conversation on GitHub.
    Already have an account?
    Sign in to comment


  



      

    

  




  
          



      

  

    
    

    

  

    Reviewers
  


    

    No reviews






    

  


      
  

    Assignees
  



        


    No one assigned







      


  


  

    Labels
  



    

      

    core

  

    functions









      

  

    

        

    Projects
  


        




    None yet




  



      


  

    
  

    Milestone
  


      No milestone





    
      
          


  

    

      
        

          
  

    Development
  



            


Successfully merging this pull request may close these issues.





  
  



      
    

  




      

    

  
      

  

    

      3 participants
    

    

        
          @asmeurer 
        
          @sympy-bot 
        
          @oscarbenjamin